Contributor's Guide

Welcome to the CUPiD Contributor's Guide!

If you would like to add a diagnostics notebook, you can follow this guide to adding diagnostics notebooks

In order to contribute code to this repository, we recommend that you get started with these steps:

0. Open an issue prior to development
1. Set up git
2. Create a fork
3. Check out a new branch
4. Make your edits
5. Merge in recent changes from master
6. Run pre-commit run --all-files locally to ensure that your code is properly formatted*
7. IF updating github.io pages, test with the steps listed below, otherwise proceed to #8:
   • $ conda activate cupid-docs
   • $ cd docs
   • $ make html
   • $ open _build/html/index.html
8. Submit a Pull Request
9. Await review
10. Update PR with any requested changes
11. Repository admins will merge the PR
12. Add your name to our contributors.md file to make sure we recognize your contributions!

* Better yet, running pre-commit install will configure git to automatically run the pre-commit checks when you try to commit changes; the commit will only proceed if all the checks pass