Thanks for taking the time to contribute to the Rivet documentation! 🙌 Please, take a minute to read the following documentation about the branching model we use and how to open a Pull Requests.
We're happy to accept pull requests from contributors outside of Indiana University, but before we can merge the code they will need to sign a Contributor License Agreement (CLA). Although a signed CLA is required to merge pull requests, we are happy to accept bug reports via GitHub issues.
The Rivet team will reach out to outside contributors to initiate the CLA process once a pull request has been opened.
We use the Git Flow branching model and naming conventions to develop new features, and do releases from this repo. Although not required to contribute, we encourage you to follow these conventions when contributing code and opening pull requests.
- Fork the main
rivet-docsrepository and then clone your fork locally. Follow these instructions on syncing your local fork. Set your newupstreamremote to point to https://github.com/indiana-university/rivet-docs.git. - Create a new feature branch off of
develop(Ideally using Git Flow) with the prefixfeature/your-featuree.g.feature/modal. - Commit your changes. Be sure to keep your commits narrow in scope and avoid committing changes not related to your feature.
- Locally merge any upstream changes into your feature branch:
git pull upstream develop. - Push your feature branch to your fork:
git push origin feature/**your feature**. - Open a pull request with a title and clear description of your feature branch against
develop.