Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 1.3 KB
Raw

Contributing guidelines

Thank you for your interest in contributing to this project! Here are some tips to get you started.

Getting started

  • Consider opening an issue if the change you are proposing is not trivial. 👍
  • Fork this repo on GitHub, then clone it to your machine.
  • Install dependencies:
scripts/install

Testing and linting

You can run code auto-formatting using:

scripts/lint

To run the test suite and code checks, run:

scripts/test

If this step passes, you should be on track to pass CI.

You can run code checks separately using:

scripts/check

Documentation

Documentation pages are located in the docs/ directory.

If you'd like to preview changes, you can run the documentation site locally using:

scripts/serve

Notes to maintainers

To make a new release:

  • Bump the version in __init__.py.
  • Edit the changelog with the set of changes since the last release.
  • Create a release commit: $ git commit -m "Release x.y.z".
  • Run $ scripts/publish to push a new release to PyPI and deploy the docs to GitHub Pages.