Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (26 loc) · 902 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 902 Bytes

Contributing

We welcome contributions to squawk-pre-commit. Here's how to get started.

Development Setup

  1. Clone the repo and install dependencies:
git clone https://github.com/kintsugi-tax/squawk-pre-commit.git
cd squawk-pre-commit
poetry install
  1. Install pre-commit hooks:
pre-commit install
  1. Run the test suite:
poetry run pytest tests/ -v

Submitting Changes

  1. Fork the repo and create a branch from main
  2. Make your changes and add tests where appropriate
  3. Ensure all tests pass and pre-commit hooks are clean
  4. Open a pull request against main

Reporting Issues

Open an issue on GitHub with a clear description of the problem and steps to reproduce.

License

By contributing, you agree that your contributions will be licensed under the MIT License.