Skip to main content

Contribution Guide

Welcome to contribute to TuyaOpen through GitHub's Fork and Pull Requests workflow. Contributions can include bug fixes, documentation improvements, and new features.

Making Changes​

  1. Install git tools on your local PC
  2. Fork the TuyaOpen repository to your GitHub account
  3. Clone your forked repository using git clone
  4. Create a local development branch with git checkout -b <BranchName>
  5. Make your code/documentation changes locally
  6. Push changes to your GitHub repository

Preparation​

  1. Verify contributions comply with Apache License 2.0 requirements
  2. Ensure code follows TuyaOpen Coding Standards
  3. Provide documentation/examples for new features
  4. Confirm documentation meets Writing Standards
  5. Group related changes in separate Pull Requests
  6. Board adaptations must comply with Chip Adaptation Guidelines

Submitting Pull Requests​

  1. Navigate to your forked repository on GitHub
  2. Click "New pull request" from your development branch
  3. First-time contributors must sign the Contributor License Agreement (CLA)
  4. Our CI system will automatically run build tests
  5. Maintainers will review your PR and provide feedback
  6. Address review comments and update your PR accordingly
  7. Approved PRs will be merged into the main repository

This completes the contribution process.