51 lines (37 loc) · 1.66 KB

Contributing

Thank you for your interest in contributing to this project! We welcome bug reports, feature requests, and pull requests.

Getting Started

Fork the repository and clone your fork locally.
Install dependencies using uv:
```
uv sync --all-groups
```
Create a new branch for your changes:
```
git checkout -b my-feature-or-fix
```

Development Workflow

Make your changes on the feature branch.
Run the test suite before opening a pull request:
```
uv run pytest
```
Ensure all tests pass and add new tests for any new behavior.

Submitting a Pull Request

Push your branch to your fork.
Open a pull request against the main branch of this repository.
Fill in the pull request template (if present) and describe what your changes do and why.
A maintainer will review your PR. Please respond to any review comments in a timely manner.
Once approved, a maintainer will merge your pull request.

Reporting Issues

Please use the GitHub Issues page to report bugs or request features. When reporting a bug, include:

A clear description of the problem.
Steps to reproduce the issue.
The expected vs. actual behavior.
Relevant environment information (OS, Python version, package version).

Code Style

Follow PEP 8 for Python code.
Keep commits focused and atomic — one logical change per commit.
Write clear, descriptive commit messages.

License

By contributing, you agree that your contributions will be licensed under the same license as this project. See LICENSE for details.