Add a contributing guide
Closed this issue · 2 comments
jjc385 commented
As we discussed on Slack, it would be useful to have some standards for contributing.
In particular, we want to be careful about having quality reviews and maintaining a clean, readable git history.
Draft of proposed contributing.md file
Contributing
- All contributions should reference an open GitHub issue in the commit message
- If an issue does not exist, feel free to open one
- Commit messages should be meaningful and follow a uniform formatting
- This is particularly important for the first line of the commit message
- I suggest https://chris.beams.io/posts/git-commit/
- Pull requests should reference the corresponding issue
- All contributions should undergo a review process before being merged into the master branch, even those made by core contributors with push access to the GitHub repository
Reviewing
TODO
Merging Pull Requests
- Rebase rather than merge, in order to keep the git history clean
- When it makes sense, squash similar commits together to keep the history clean
- This will often happen when corrections are added during review
jjc385 commented
Is there anything we want to say about the review process?
jjc385 commented
Suggestions from Slack discussion:
preventing barriers to entry
- make it clear these are rules for core contributors, and we'll help everyone else
- also add something along these lines to the readme
commit messages
- we'll copy over the seven rules from the article
- mention how the first line is the important part, but sometimes it helps to clarify further