We welcome contributions to the Arduino ESP32 project!
How to Contribute¶
Contributions to the Arduino ESP32 (fixing bugs, adding features, adding documentation) are welcome. We accept contributions via Github Pull Requests.
Before sending us a Pull Request, please consider this:
Is the contribution entirely your own work, or is it already licensed under an LGPL 2.1 compatible Open Source License? If not, cannot accept it.
Is the code adequately commented and can people understand how it is structured?
Is there documentation or examples that go with code contributions?
Are comments and documentation written in clear English, with no spelling or grammar errors?
Example contributions are also welcome.
If you are contributing by adding a new example, please use the Arduino style guide and the example guideline below.
If the contribution contains multiple commits, are they grouped together into logical changes (one major change per pull request)? Are any commits with names like “fixed typo” squashed into previous commits?
If you’re unsure about any of these points, please open the Pull Request anyhow and then ask us for feedback.
Pull Request Process¶
After you open the Pull Request, there will probably be some discussion in the comments field of the request itself.
Once the Pull Request is ready to merge, it will first be merged into our internal git system for “in-house” automated testing.
If this process passes, it will be merged into the public GitHub repository.
Example Contribution Guideline¶
Check if your example proposal has no similarities to the project (already existing examples)
Use the Arduino style guide
Add the header to all source files
Add the README.md file
Add inline comments if needed
Test the example
All the source files must include the header with the example name and license, if applicable. You can change this header as you wish, but it will be reviewed by the community and may not be accepted.
Ideally, you can add some description about the example, links to the documentation, or the author’s name. Just have in mind to keep it simple and short.
The README.md file should contain the example details.
Please see the recommended README.md file in the example template folder.
Inline comments are important if the example contains complex algorithms or specific configurations that the user needs to change.
Brief and clear inline comments are really helpful for the example understanding and it’s fast usage.
See the FTM example as a reference.
Be sure you have tested the example in all the supported targets. If the example works only with specific targets, add this information in the README.md file on the Supported Targets and in the example code as an inline comment.
Before a contribution can be accepted, you will need to sign our contributor agreement. You will be prompted for this automatically as part of the Pull Request process.