Contributing#

To contribute to the code base, make the changes on a branch and submit a merge request.

Before submitting a merge request ensure that:

  • Run ./repo.sh test --suite unittest runs and no errors have been introduced

  • Run ./repo.sh test --suite pytest runs and no errors have been introduced

  • Run ./repo.sh format to ensure that your code is linted correctly

  • Run ./repo.sh docs to ensure that you can generate docs correctly

  • Bump VERSION file with the new version

  • Update CHANGELOG.md with a description of what you did

Testing via Kit + Rendering#

For involved/large changes it is suggested that you test against a project that will exercise your changes. It is frequently suggested to repo source link your changes into kit and rendering and try to build + test. I lazily will publish a test package of say repo man with a version of xx.yy.zz-rc1 with the rc int incrementing as I address discovered issues. Fork Kit, update the repo-deps in both kit and rendering, and let CI churn.