Add CONTRIBUTING.md #325
Merged
Add CONTRIBUTING.md #325
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
Add a very short guide for contributors, mainly referencing the existing RFCs which detail coding style and git commit rules.
|
Cool. |
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.
Add a very short guide for contributors, mainly referencing
the existing RFCs which detail coding style and git commit
rules.
I was going to add a short description of the contribution process to the top of this document as well (e.g. create changes, add tests, update documentation, ensure changes adhere to RFC 7, ensure commits adhere to RFC 1, submit PR, accept feedback), but I wanted to keep the document as short as possible. If we think more context is needed here, I could easily add that extra text.
I also tried not to reference any particular flux-framework project such that CONTRIBUTING.md could be copied directly to all flux projects, if desired.