Skip to content

contributing.rst

Latest commit

 

History

History
57 lines (36 loc) · 1.63 KB

contributing.rst

File metadata and controls

57 lines (36 loc) · 1.63 KB
Raw

Contributing

Bug reports and feature requests

Bugs and new feature requests can be submitted to the issue tracker on GitHub. See this StackOverflow post for tips on how to craft a helpful bug report.

Development setup

Clone the repository:

git clone https://github.com/{{ cookiecutter.org }}/{{ cookiecutter.repo }}
cd {{ cookiecutter.repo }}

Then initialize a virtual environment:

python3 -m virtualenv venv
source venv/bin/activate
python3 -m pip install -e '.[dev,tests,docs]'

We use prek to run conformance tests before commits. This provides checks for:

  • Code format and style
  • Added large files
  • AWS credentials
  • Private keys
  • Other formatting things

Before your first commit, run:

prek install

Style

Code style is managed by Ruff, and should be checked via prek hook before commits. Final QC is applied with GitHub Actions to every pull request.

Tests

Tests are executed with pytest:

pytest

Documentation

The documentation is built with Sphinx, which is included as part of the docs dependency group. Navigate to the docs/ subdirectory and use make to build the HTML version:

cd docs
make html

See the Sphinx documentation for more information.