We are happy to welcome developers from the community to contribute to Taro 《Taro invites you to join in community building》。
- Submit an RFC or view the relevant RFC, you can view taro-rfcs repository
- Share your case, just submit the mini program QR code, you can submit to taro-user-cases
- Share your SDK, components , UI libary, project, you can submit to Examples
- Share your experience (open source projects, tutorials, articles) you can submit to awesome-taro Or contribute to the 「Taro Community」Official Accounts
Before submitting your code for contribution, you need to spend some time reading the following to ensure that the contribution is in compliance with the specification and will help the community.
|The babel preset for Taro projects|
|Taro's core API for application developers|
|The utils used internally by Taro|
|Public API for all platform of @tarojs/taro|
|H5 API for @tarojs/taro|
|Taro H5 Router|
|React renderer for mini program based on react-reconciler|
|Taro Development Tools|
|Taro extensions, including jQuery API, etc.|
|Internal use of auxiliary method sets for CLI and runner|
|Taro Plugin Kernel|
|Webpack loader exposed for use by @tarojs/mini-runner and @tarojs/webpack-runner|
|Common tool functions exposed to @tarojs/mini-runner and @tarojs/webpack-runner|
|Taro H5 Webpack package builder|
|Taro mini program Webpack package tools|
|Taro H5 Standard component library|
|Taro Mini Program Reverse compiler|
|Runtime adapter for reverse conversion|
|Taro ESLint Rules|
|Taro ESLint Plugin|
If you are submitting a bug report, please click
New issue 。
If you want to implement an important feature for Taro, you need to write an RFC document first, following Taro's RFC System，The code can be submitted only after it has been discussed and refined by the community.
You need to make sure your Node.js version is greater than 8 to clone the repository locally. Run the following command.
$ npm install # or yarn
$ npm run bootstrap
$ npm run build
Taro repository adheres to the Angular Style Commit Message Conventions，So be sure to follow this when entering your commit message, please make sure to follow this convention when publish.
tsconfig.jsonin the relevant package directory for details.
- Styles：follow the
.stylelintrcstyle in the relevant package directory.
Pull Request Guides
- Make sure that
npm run buildcompiles successfully;
- Be sure to submit code that follows the specifications specified in
.stylelintrcin the relevant package;
- When the
package.jsonof the package in question contains the
npm testcommand, it must be ensured that all test cases are required to pass;
- When a test case is available for the package in question, add the corresponding test case to your submitted code as well;
- When contribute Code, the commit message needs to follow Angular Style Commit Message Conventions。
- If the contribute code is very complex, you can split the PR into several commits. We will squash when merging.
Thanks to all the developers who have contributed code to Taro：