Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 1.25 KB

Contributing

We welcome contributions to this project! Here are some guidelines to follow:

Reporting Bugs

Before submitting a bug report, please check the issue tracker to see if the issue has already been reported. If it has, please add any additional info you have to the existing issue.

If the issue has not been reported, open a new issue and provide as much detail as possible about the bug and how to reproduce it.

Suggesting Enhancements

We also welcome enhancement suggestions! Please explain in detail how the enhancement would work and why you think it would be useful to add.

Pull Requests

If you would like to contribute code:

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch
  4. Make your changes and commit them with clear commit messages
  5. Push your branch to your fork
  6. Open a pull request against the main repository

Pull requests should:

  • Address only one issue or add one feature
  • Update docs and tests accordingly
  • Follow the existing code style
  • Pass all CI checks

We will review the pull request as soon as possible. Thank you for contributing!

Code of Conduct

Please note that this project has a Code of Conduct. By participating in this project, you agree to abide by its terms.