Skip to content

Latest commit

 

History

History
23 lines (13 loc) · 809 Bytes

DEVELOPMENT.md

File metadata and controls

23 lines (13 loc) · 809 Bytes

Development Notes

Docs

A good way to work on docs is to use sphinx-autobuild that will build the docs and start a local Web server that will auto-reload on save.

sphinx-autobuild --watch ledgereth/ docs/ build/docs/

Then you can visit http://127.0.0.1:8000 to view the docs locally.

Linting

Make sure to lint your work:

python setup.py lint

Release

  1. Bump version (bump2version patch). This will update the version in source and make a commit and version tag. Don't forget to push your tags: git push --follow-tags.
  2. Merge branch into master
  3. Create GitHub release with tag created by bump2version and release will happen automatically

TIP: Instead of --follow-tags, you can configure git to always do this on push: git config --global push.followTags true