Get started on documenting how to contribute #271
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
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.
By convention, guidelines for contributors are put into a file named
CONTRIBUTING.md(I believe GitHub renders that specially). There are some web pages that have suggestions for how such a file could be structered, for example https://mozillascience.github.io/working-open-workshop/contributing/. I kept it small (and moved some text from the README) for now. I mainly wanted to have a place where I can put the code style guidelines so that I can refer to it in PRs.This also adds the
.clang-formatfile that is part of PR #266 just so it can be used manually for formatting new files as the style guide instructs.