Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 1.92 KB
Raw

This project welcomes contributions. All Pull Requests should include proper testing, documentation, and follow all existing checks and practices.

Development Workflow

  1. Create a branch off main
  2. Develop, add tests, ensure all tests are passing
  3. Push up to GitHub (running pre-commit)
  4. Create a PR, get approval
  5. Merge the PR to main
  6. On main: Create a tag with just tag
  7. Do any manual or integration testing
  8. Push the tag to GitHub just deploy-tag, which will create a Draft release and upload to test.pypi.org via CICD
  9. Approve the release on GitHub, which will upload to pypi.org via CICD

Versioning

Development

Just

This project uses just (link)

Pre-Commit

This project uses pre-commit (link).

Install it with just install-precommit

Installing Locally

Install with just install

Linting

This project uses black (link), and ruff (link). They run with pre-commit but you can run them directly with just lint in the root.

Testing

This project utilizes Doctests and pytest. With the dev extras installed, you can run all tests with just test in the root of the project. It will automatically pick up it's configuration from pyproject.toml