Contributing Guide

We welcome contributions from the community! If you would like to participate in the project, here are some things to consider.

Code of Conduct

Please read and follow the Code of Conduct.

Submission Guidelines

Submitting an Issue

Before starting work on a pull request, please check if there is an open issue that your contribution relates to. If there is no such issue, please create a new issue to describe your contribution and start the discussion.

Submitting a Pull Request (PR)

When you are ready to submit your contribution, please create a pull request. Here are some things to consider:

Add a descriptive title to the pull request.
Link the related issue in the pull request.
Ensure that all tests are successful and no warnings occur.
Use a descriptive commit message.

Workflow

Find an issue that you would like to work on or create a new issue to propose a new feature or improvement.
Fork the repository on GitHub.
Create a new branch for your changes.
Make your changes and commit them to your branch.
Push your branch to your fork on GitHub.
Create a new pull request from your branch.

A maintainer will review your pull request and may ask you to make additional changes or provide more information before it is merged.

License

By submitting a contribution, you agree to have your contribution published under the project's license. Please make sure you have the right to submit your contribution under this license.

Acknowledgements

Thank you for wanting to contribute to the project! We appreciate the effort and time you are putting into your contribution.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!