We welcome contributions from external contributors. This document describes the contribution process: from proposing a change to getting it merged into CMake Cookbook. The process for contributing is exactly the same for the core development team and for external contributors:
- Maintainers do not push directly to the repository.
- Maintainers do not review their own patches.
- Approval of one or more maintainers is sufficient for trivial patches. Trivial patches are typos and trivial bugfixes
- For any patch that is not trivial, two maintainers need to review and approve the patch.
- Make sure you have a GitHub account.
- Fork the dev-cafe/cmake-cookbook repository on GitHub.
- On your local machine, clone your fork of the CMake Cookbook repository.
- The Psi4 documentation has more detailed instructions for interacting with your fork which can be found here. and here.
- Add some really awesome code to your local fork. It's usually a good idea to make changes on a branch with the branch name relating to the feature you are going to add. A style guide is available in the STYLE_GUIDE.md file.
- Signoff your patches by using the
git commit -scommand to commit them. This will show the CMake Cookbook team that you have read and agreed to the Developer Certificate of Origin (DCO). - When you are ready for others to examine and comment on your new feature,
navigate to your fork of CMake Cookbook on GitHub and open a pull request (PR)
towards the
masterbranch. Note that after you launch a PR from one of your fork's branches, all subsequent commits to that branch will be added to the open pull request automatically. Each commit added to the PR will be validated for mergeability, compilation and test suite compliance; the results of these tests will be visible on the PR page. - The title of your pull request should be marked with
[WIP]if it’s a work in progress. Feel free to use as many labels as you think necessary! - Update the
CHANGELOG.mdfile. We follow the conventions and recommendations detailed at keepachangelog.com - When the code is ready to go, make sure you run the full test suite on your local machine to check that nothing is broken. Read here for further details on testing
- When you're ready to be considered for merging, check the "Ready to go" box on the PR page to let the CMake Cookbook team know that the changes are complete. The code will not be merged until this box is checked, the continuous integration services return passing checkmarks, and maintainers give "Approved" reviews.
- We do not require any formal copyright assignment or contributor license agreement.
- Any contributions intentionally sent upstream are presumed to be offered under the terms of the OSI-approved MIT License.
- You should read the DCO and certify that you agree to it by signing off your patch using the
git commit -scommand. Note that signing off and GPG-signing a commit are not the same thing and we do not require GPG-signing your commits. We use a DCO bot to ensure that submitted patches are signed off. The bot will block merging and suggest actions to resolve the block.