Contributing Guide
Thank you for your interest in the uni-app Development Guide! We welcome community members to contribute and help us improve this documentation.
How to Contribute
Reporting Issues
If you find errors, outdated information, or have suggestions for improvement in the documentation, please report them through:
- Submitting an Issue on our GitHub repository
- Clearly describing the problem and providing relevant context
- If possible, suggesting corrections or solutions
Submitting Content
If you'd like to contribute content directly, follow these steps:
- Fork our repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Submit a Pull Request
Content Guidelines
To ensure documentation quality and consistency, please follow these guidelines:
Documentation Style
- Use clear, concise language
- Avoid overly technical terminology; if necessary, provide explanations
- Code examples should be simple to understand and ready to run
- Document structure should comply with Markdown standards
Code Examples
- All code examples should be tested to ensure they work correctly
- Code should follow good programming practices and style guides
- Provide necessary comments to help readers understand the code logic
Review Process
All contributions will go through the following review process:
- Initial review: Check formatting, grammar, and basic content
- Technical review: Verify the accuracy of technical content
- Final review: Ensure consistency with existing documentation and overall quality
Copyright Notice
By submitting content, you agree to license your contribution to us, allowing it to be published under the MIT license.
Contact Us
If you have any questions, please contact us through:
- Email: contact@yanshengcha.com
- WeChat Official Account: uni-app Development Guide