Developer Guide

Get set up and write new code

1. Fork model_catalogs to your GitHub account.

2. Clone the package from your fork on GitHub (following these instructions).

3. Make your code changes in a branch.

4. You’ll need to lint your code to pass the precommit tests. Install the development packages and run with pre-commit run –all-files`.

5. Run tests, including the slow tests, to make sure your code doesn’t break anything.

6. When your code is ready, open a pull request from your fork and branch back to the base repo main branch.

7. Check the pull request checklist and be sure that the docs notebooks still run correctly and that you update “What’s New” in “docs” with your changes.

Release steps

1. Make sure docs notebooks all run still and save to repo if there are changes.

2. Update the “What’s New” doc page to the newest release version.

3. Go to the package releases and add a new one to match the What’s New page.

4. PyPI will update to this version through a GitHub Action when the release is made.