Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
17 lines (12 loc) · 522 Bytes

CONTRIBUTING.md

File metadata and controls

17 lines (12 loc) · 522 Bytes

Contributing to Hierocode

We love your input! We want to make contributing to this project as easy and transparent as possible.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes (pytest).
  4. Format your code with black and ruff.
  5. Issue that pull request!

Code Guidelines

  • Rely on Pyydantic for parsing configuration / options.
  • Maintain type hints across function definitions.
  • Write tests.