Welcome to the contributions section! We highly appreciate your interest in contributing to our project. Whether it's fixing bugs, adding new features, or improving documentation, every contribution helps make this project better.
- Find an Issue: Before reporting a new issue, please check the issue tracker to avoid duplicates.
- Create an Issue: If no existing issue addresses the problem, create a new one. Provide as much detail as possible to help us understand the issue.
- Enhancement Suggestions: For any feature requests or suggestions for improvement, check the issue tracker first to avoid duplicates. If no similar issue exists, feel free to open a new issue describing your suggestion.
- Find an Issue: Look for existing issues related to your interest or start a new one discussing your idea.
- Fork and Clone: Fork the project repository, clone it locally, and create a new branch for your contribution.
- Code Requirements:
- Follow Coding Standards: Ensure your code adheres to the project's coding standards and style guidelines.
- Write Tests: Include unit tests for new features or fixes. Contributions will only be accepted if all tests pass.
- Update Documentation: If adding new features or changing existing ones, update the relevant documentation so users and developers can understand how to use it.
- Commit Messages: Use clear and concise commit messages, explaining the reason and content of your changes.
- Submit a Pull Request (PR): Push your changes to your fork and submit a pull request to the main project. Your PR will be reviewed by the maintainers.
Your help in translating the project's documentation and interface can reach more users worldwide. If you're fluent in a language other than English, Chinese and would like to contribute by translating, please:
- Check the issue tracker for open translation requests or open a new issue to discuss your planned contribution.
- Follow the guidelines provided for translations, ensuring consistency and accuracy.
- Submit your translations through a Pull Request, clearly stating the language and parts you've worked on.
Interested in getting more involved? We'd love to have you join our community of contributors. Your efforts are what make this project thrive. We look forward to your contributions!