Skip to content

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:

  1. Submitting an Issue on our GitHub repository
  2. Clearly describing the problem and providing relevant context
  3. If possible, suggesting corrections or solutions

Submitting Content

If you'd like to contribute content directly, follow these steps:

  1. Fork our repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. 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:

  1. Initial review: Check formatting, grammar, and basic content
  2. Technical review: Verify the accuracy of technical content
  3. Final review: Ensure consistency with existing documentation and overall quality

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:

Last Updated:

一次开发,多端部署 - 让跨平台开发更简单