-
Notifications
You must be signed in to change notification settings - Fork 2
Commit and Pull Request Protocols
Version control is the living history of the project. It not only provides backups and a way to share changes, but is a critical component of scientific reproducibility of results by the wider community and helps future developers understand the code. Good commit messages are a essential to ensure the history of the project is useful. Messages should follow the template below, with an emphasis on the why of a set of changes, not just the what. It only take as few seconds to minutes to fill out the template, and can save future developers, including future you, hours to days in understanding the code.
[ Provide a general summary of your changes in the Title above ]
[ Describe your changes in detail ]
[ Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. ]
[ What types of changes does your code introduce? Put an x in all the boxes that apply: ]
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to change)
[ Go over all the following points, and put an x in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! ]
- My change requires a change to the documentation.
- I have updated the CHANGELOG.md.
- I have updated the documentation accordingly.
- I have read the CONTRIBUTING document.
- I have added tests to cover my changes.
- All new and existing tests passed.
[ this template is from https://www.talater.com/open-source-templates/#/page/99 ]