Developer Notes

Creating a new release

In order to create a new release, follow those steps:

1. Update CHANGELOG.md and send a pull request to master.
2. Merge the pull request into master.
3. Pull the master to your local repo and check it out.
4. Tag the commit with an annotated tag:
   git tag -a vX.Y.Z
   Do not use trailing zeros (Use v0.3 instead of v0.3.0).
   Use the markdown from the CHANGELOG.md as the description of the tag.
5. Build the project to create the sdist and wheel under dist/.
6. upload the files to pypi:
   twine upload --repository pypi dist/*
7. push the tag to github:
   git push --tags