Move the docs/contributing.rst contents to CONTRIBUTING.rst
#417
Conversation
This file contains hidden or 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
This change makes it easier for people to contribute to the project when opening a PR. Currently, GitHub shows links to `CONTRIBUTING.rst` when opening a PR, but when people click on those links they are simply told "Go to a third-party website to view the contributing guidelines". This change replaces the manual redirect with actual content so that no third-party website (in this case, Read the Docs) is necessary to understand the contributing guidelines. In addition, `docs/contributing.rst` now uses a directive to `include` the contents of `CONTRIBUTING.rst`. This was tested by building the documentation locally and confirming that the HTML documentation still contained the contributing guidelines. The result is a streamlined contributing experience from within GitHub, no duplicated content, and no changes to the built documentation.
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 change makes it easier for people to contribute to the project when opening a PR.
Currently, GitHub shows links to
CONTRIBUTING.rstwhen opening a PR, but when people click on those links they are simply told "Go to a third-party website to view the contributing guidelines":This change replaces the manual redirect with actual content so that no third-party website (in this case, Read the Docs) is necessary to understand the contributing guidelines.
In addition,
docs/contributing.rstnow uses a directive toincludethe contents ofCONTRIBUTING.rst.This was tested by building the documentation locally and confirming that the HTML documentation still contained the contributing guidelines.
The result is a streamlined contributing experience from within GitHub, no duplicated content, and no changes to the built documentation.