38 lines
1.8 KiB
Markdown
38 lines
1.8 KiB
Markdown
|
# Contributions Guide
|
||
|
|
|
||
|
|
We welcome contributions to the esp-idf project!
|
||
|
|
|
||
|
|
## How to Contribute
|
||
|
|
|
||
|
|
Contributions to esp-idf - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via the [Github Pull Request](https://help.github.com/articles/about-pull-requests/) feature.
|
||
|
|
|
||
|
|
## Before Contributing
|
||
|
|
|
||
|
|
Before sending us a Pull Request, please consider this list of points:
|
||
|
|
|
||
|
|
* Is the contribution entirely your own work, or already licensed under an Apache License 2.0 compatible Open Source License? If not then we cannot accept it.
|
||
|
|
|
||
|
|
* Does any new code conform to the esp-idf Style Guide? (Style Guide currently pending).
|
||
|
|
|
||
|
|
* Is the code adequately commented for people to understand how it is structured?
|
||
|
|
|
||
|
|
* Is there documentation or examples that go with code contributions? [There are additional suggestions for writing good examples in the examples README](examples/README.md).
|
||
|
|
|
||
|
|
* Are comments and documentation written in clear English, with no spelling or grammar errors?
|
||
|
|
|
||
|
|
* 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 onto the public github repository.
|
||
|
|
|
||
|
|
## Legal Part
|
||
|
|
|
||
|
|
Before a contribution is accepted, you will need to sign our Contributor Agreement. You will be prompted for this automatically as part of the Pull Request process.
|