Add CONTRIBUTING.md

This commit is contained in:
Yukino Song
2025-07-14 03:52:03 +08:00
parent f59080817c
commit 90c8eed143

74
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,74 @@
# Contributing Guidelines
Thank you for your interest in contributing to this project! We welcome contributions from the community and appreciate your efforts to make this project better.
## How to Contribute
### Reporting Issues
- Use the GitHub issue tracker to report bugs or request features
- Before creating a new issue, please search existing issues to avoid duplicates
- Provide clear, detailed descriptions with steps to reproduce bugs
- Include relevant system information and logs when applicable
### Code Contributions
#### Getting Started
1. Fork the repository
2. Create a new branch for your feature or bugfix: `git checkout -b feature/your-feature-name`
3. Make your changes
4. Test your changes thoroughly
5. Commit your changes with clear, descriptive messages
6. Push your branch to your fork
7. Create a pull request
#### Code Standards
- Follow the existing code style and formatting conventions
- Write clear, readable code with appropriate comments
- Ensure all changes are sound
- Keep commits focused and atomic
#### Pull Request Guidelines
- Provide a clear description of what your PR does
- Reference any related issues using keywords like "Fixes #123"
- Include screenshots or examples if your changes affect the UI
- Be responsive to feedback and suggestions during code review
## Important Rules
### AI-Generated Code Policy
**AI-generated code is acceptable, but please make sure you have thoroughly reviewed and understand what it does.**
When using AI tools to generate code:
- Review every line of generated code carefully
- Understand the logic and potential implications
- Test the code thoroughly in your environment
- Ensure it follows project conventions and best practices
- Take responsibility for any issues that may arise from the generated code
***IMPORTANT: Don't trust AI generated tests. Test each modifications manually.***
### Code Review Process
- All contributions must go through code review
- Maintainers will review your pull request and provide feedback
- Address all feedback before the PR can be merged
- Be patient and respectful during the review process
## Development Setup
Please refer to the README.md file for instructions on setting up your development environment.
## Questions?
If you have questions about contributing, feel free to:
- Open an issue for discussion
- Contact the maintainers
- Check existing documentation
Thank you for contributing!