Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Improved contributing guide #1342

Open
wants to merge 34 commits into
base: main
Choose a base branch
from

Conversation

gabrielmfern
Copy link
Collaborator

@gabrielmfern gabrielmfern commented Mar 5, 2024

This new contributing guide includes a lot of changes and a lot of additions. First it changes
the CONTRIBUTING.md to be a pointer into the contributing guide in the docs because of its new size
and level of detail.

Secondly, instead of having one page for the contributing guide, there's a new section for it
with its pieces inside.

screenshot for how the contributing section looks like in the sidebar

The new contributing guide includes two extra things that I've found are helpful, that other
projects include it themselves:

  1. A codebase overview
    • Mentioning how we do things, what tools we use and how our files are structured
  2. A step-by-step of the development workflow,

As for the two sections that we had before for Opening issues and Opening pull requests,
they are now pages in the docs. To them, I've also added things that I think are really
important, that might guide people coming across it to do better work.

Opening issues section
Codebase overview section
Opening pull requests section

Copy link

vercel bot commented Mar 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
react-email ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 2:31pm
react-email-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 2:31pm

@gabrielmfern
Copy link
Collaborator Author

The staging deploy also worked out, if anyone wants to check it out https://react-email-feat-improved-contributing-guide.mintlify.app/contributing/opening-issues.

@gabrielmfern gabrielmfern force-pushed the feat/improved-contributing-guide branch from 2d5a033 to 4c28ec7 Compare March 5, 2024 15:31
@gabrielmfern gabrielmfern added the Type: Documentation Improvements or additions to documentation label Mar 6, 2024
@gabrielmfern gabrielmfern force-pushed the feat/improved-contributing-guide branch from 112ef3f to b6effcb Compare March 27, 2024 12:25
@gabrielmfern gabrielmfern force-pushed the feat/improved-contributing-guide branch from 9538b39 to c18a2c1 Compare April 24, 2024 15:47
@gabrielmfern gabrielmfern removed the request for review from vcapretz May 13, 2024 13:12
@gabrielmfern gabrielmfern force-pushed the feat/improved-contributing-guide branch from c18a2c1 to 34f777b Compare June 4, 2024 16:50
@gabrielmfern gabrielmfern force-pushed the feat/improved-contributing-guide branch from 6940b1d to dc64ebc Compare August 5, 2024 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve CONTRIBUTE.md for a proper contributing guide
2 participants