Dev environment setup is largely the same as setup in the tutorial, but instead of pip installing the version
in pypi, you can set up using pip install --editable .
.
In pull requests please:
- cite the issue reference
- update the changelog (create a new version if there is no release candidate)
Please make sure that you have
run Black with -l 120
, mypy,
and flake8 before you submit your changes. Please run yarn format
to format the javascript code.
The build will fail for flake8, Black, and Prettier changes.
PRs without a test will almost certainly be rejected.
Do also make sure to run the webapp and make sure you haven't broken anything.
When releasing a new version, please increment the version number in:
notebooker/version.py
.circleci/config.yml
docs/conf.py
notebooker/web/static/package.json
This build will validate that these numbers match those given in .circleci/config.yml
.