Thank you for considering contributing to our project! We welcome your help to make our project better.
To contribute, please follow these guidelines:
- Fork the repository on GitHub.
- Clone the forked repository to your local machine.
- Create a new branch for your contribution.
- Make your changes and test them thoroughly.
- Commit your changes and push them to your fork on GitHub.
- Create a pull request on the original repository.
If you encounter any issues or have suggestions, please create an issue on GitHub.
When creating an issue, please provide detailed information, including:
- A clear and descriptive title.
- A description of the issue or suggestion.
- Steps to reproduce (if it's a bug).
- Your operating system and version.
- Any relevant information that could help in resolving the issue.
- Follow the existing code style in the project.
- Use clear and descriptive variable and function names.
- Comment your code as needed to explain complex parts.
Ensure that your code is well-tested. Write test cases for new features and modifications.
- Keep your pull requests focused on a single issue or feature.
- Reference the issue number in the pull request description.
- Include a clear description of your changes.
- Make sure your code passes all tests.
- Be responsive to comments and requests for changes.
By contributing, you agree that your contributions will be licensed under the project's LICENSE.
Thank you for your contribution! Your help is greatly appreciated.