Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

67 lines (41 loc) · 1.8 KB
Raw

Guidelines for Contributing

Contributions are welcomed in all forms. These may be bugs, feature requests, documentation, or examples. Please feel free to:

  • Submit an issue
  • Open a pull request
  • Help with outstanding issues and pull requests

Open an Issue

If you find a bug or have a feature request, please open an issue on GitHub. Please check that it is not one of the open issues.

Local Development Steps

Create a forked branch of the repo

Do this once but keep it up to date

  1. Fork wd60622/conjugate GitHub repo

  2. Clone forked repo and set upstream

    git clone git@github.com:<your-username>/conjugate.git
cd conjugate
git remote add upstream git@github.com:wd60622/conjugate.git

Setup Local Development Environment

The project is developed with Poetry.

In the root of the repo, run:

poetry install

And also install the pre-commit hooks with:

pre-commit install

Pull Request Checklist

Please check that your pull request meets the following criteria:

  • Unit tests pass
  • pre-commit hooks pass
  • Docstrings and examples render correctly in the documentation

Documentation

The documentation is built using MkDocs and mkdocstrings.

The docstrings should be of Google Style.

Automations

Formatting will be down with ruff via the pre-commit hooks.

Tests will run on each pull request.

Documentation will be updated with each merge to main branch.

Package release to PyPI on every GitHub Release.