Thank you for considering contributing to this project! Please follow these guidelines to help us maintain a high-quality codebase and collaborative environment.
- Fork the repository and create your branch from
main. - Describe your changes in clear, concise commit messages.
- Test your changes before submitting a pull request.
- Submit a pull request with a clear description of your changes and the problem they solve.
Please read and follow our Code of Conduct to foster a welcoming and respectful community.
- Ensure your branch is up to date with
main. - Reference related issues in your PR description (e.g.,
Fixes #123). - Include relevant tests and documentation updates.
- Wait for review and respond to feedback.
- Write clear, maintainable, junior friendly and well-documented code.
- Use descriptive variable and function names.
- Search existing issues before opening a new one.
- Provide a clear and descriptive title and detailed information.
- Include steps to reproduce, expected behavior, and screenshots if applicable.
- Explain the motivation and use case for the feature.
- Propose a possible implementation or design if possible.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Fix bug" not "Fixes bug").
- Limit the first line to 72 characters or less.
If you have any questions, feel free to open an issue or start a discussion.
Thank you for helping us improve this project!