Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 2.2 KB
Raw

Contributing Guide

  • Check the GitHub Issues for open issues that need attention.

  • Follow the How to submit a contribution Guide.

  • Make sure unit tests pass. Please read how to run unit tests below.

  • If you are fixing a bug:

    • If you are resolving an existing issue, reference the issue ID in a commit message (e.g., fixed #XXXX).
    • If the issue has not been reported, please add a detailed description of the bug in the Pull Request (PR).
    • Please add a regression test case to check the bug is fixed.

  • If you are adding a new feature:

    • Please open a suggestion issue first.
    • Provide a convincing reason to add this feature and have it greenlighted before working on it.
    • Add tests to cover the functionality.

  • Please follow Style Guide for Python Code.

Setting up development environment

You can install the development environment, i.e. all the dependencies required to run all tests and checks that are run when you submit a PR, by following these steps:

  1. Install hatch.
  2. Clone the repository: 
    git clone https://github.com/manmartgarc/stochatreat
cd stochatreat
  3. Confirm hatch picked up the project: 
    hatch status

Tests

To run tests in the default environment:

hatch run default:test

To run tests in all environments:

hatch run all:test

Format

When submitting a PR, the CI will run make format and also make lint to check the format of the code. You can run this locally by running:

hatch fmt

Release

  • Run hatch to update the version number file and create a new tag:

    hatch version [major|minor|patch]

  • Commit the changes and push them to your fork.

  • Tag the new version:

    git tag -a v0.0.0 -m "v0.0.0"
git push origin v0.0.0

  • Submit a PR.

  • Once the PR is merged, run hatch publish to create a new release in PyPI.