-
Notifications
You must be signed in to change notification settings - Fork 665
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
gabrielmfern
wants to merge
34
commits into
main
Choose a base branch
from
feat/improved-contributing-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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
force-pushed
the
feat/improved-contributing-guide
branch
from
March 5, 2024 15:31
2d5a033
to
4c28ec7
Compare
gabrielmfern
added
the
Type: Documentation
Improvements or additions to documentation
label
Mar 6, 2024
gabrielmfern
force-pushed
the
feat/improved-contributing-guide
branch
from
March 27, 2024 12:25
112ef3f
to
b6effcb
Compare
gabrielmfern
force-pushed
the
feat/improved-contributing-guide
branch
from
April 24, 2024 15:47
9538b39
to
c18a2c1
Compare
gabrielmfern
force-pushed
the
feat/improved-contributing-guide
branch
from
June 4, 2024 16:50
c18a2c1
to
34f777b
Compare
gabrielmfern
force-pushed
the
feat/improved-contributing-guide
branch
from
August 5, 2024 16:21
6940b1d
to
dc64ebc
Compare
gabrielmfern
force-pushed
the
feat/improved-contributing-guide
branch
from
November 15, 2024 14:29
0d2ace0
to
28f35d5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The new contributing guide includes two extra things that I've found are helpful, that other
projects include it themselves:
As for the two sections that we had before for
Opening issues
andOpening 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