Create Documentation To Help Contributors #458
Merged
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
|
👍 This PR helped me figure out how to submit a test-passing PR for an example update. |
|
Thanks! |
amosshapira
pushed a commit
to amosshapira/troposphere
that referenced
this pull request
Oct 24, 2016
* Add contribution 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.
"Explicit is better than implicit."
I got all of the instructions in this documentation commit by following the bread crumbs for the cloudtools/troposphere GitHub repository. It was not hard, but it wasn't as easy as reading a markdown document. My hope is that this commit will make it easier for more people to contribute quality code to this project.
Since there was no
docsdirectory, I made an aesthetic choice to put theCONTRIBUTE.mdfile into a sub-directory. I am open to moving it.