Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (47 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

60 lines (47 loc) · 2.29 KB

Contributing Guidelines

Thank you for your interest in contributing! We welcome contributions to this project.

How to Contribute

Creating an Issue

If you have identified an area for improvement, open an issue to let us know. Before you start working on your code contribution, we recommend that you open an issue to discuss it with the community too.

Code Contributions

  1. Fork the repository
  2. Create your branch from main.
  3. Create a virtual environment: 
    python -m venv .venv
  4. Install the dependencies: 
    pip install -r requirements-dev.txt
# or
make install
  5. Write tests for new features or bug fixes. See examples under tests directory.
  6. Run all tests locally to ensure nothing breaks: 
    make test
  7. Commit your changes with a clear, descriptive message, following Conventional Commits.
  8. Push your branch and open a pull request against main.
  9. Wait for a review and feedback for your changes to be accepted and merged.

Pull Request Guidelines

  • Make sure your properly describe your changes in the pull request template.
  • Keep PRs focused and small.
  • Ensure all tests pass and add new tests if needed.
  • Update documentation if your changes affect usage.

Code Style

  • Follow PEP 8 for Python code.
  • Use clear, descriptive variable and function names.
  • Format your code with black and isort before committing. 
    make format

Need help? Do not hesitate to open an issue!