We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct.
If you find any issues with the project, please report them using our issue tracker on GitHub. Before creating a new issue, please search the existing ones to avoid duplicates.
When reporting an issue, provide as much detail as possible, including steps to reproduce the problem, expected behavior, and your operating system environment.
We appreciate your ideas for improving the project. If you have any suggestions, please create a new issue on our issue tracker and include a clear description of your enhancement proposal.
We encourage you to contribute to the project by submitting pull requests with bug fixes or new features. To do this, follow these steps:
- Fork the repository and create your branch from
main. - Make your changes and ensure they follow the project's coding style and conventions.
- Write tests to cover your changes, if applicable.
- Ensure all existing tests pass by running the test suite.
- Make sure your code lints without any errors.
- Commit your changes with a descriptive commit message.
- Push your branch to your forked repository.
- Open a pull request to the main repository's branch.
To help us review your pull request in a timely manner, please follow these guidelines:
- Provide a clear and descriptive title for your pull request.
- Include a summary of the changes made and any additional context if necessary.
- Reference any related issues or pull requests in the description.
- Ensure your code follows the project's coding style and conventions.
- Include any necessary tests with your changes.
Please review and adhere to our Code of Conduct while participating in this project.
By contributing to this project, you agree that your contributions will be licensed under the Project License.
We appreciate your interest and support in improving this project. Thank you for your contributions!