X-Git-Url: https://granicus.if.org/sourcecode?a=blobdiff_plain;f=CONTRIBUTING.rst;h=3a9bd581da0e3e10dea4063ac801b151155cf157;hb=75a4007675185a94e51f5275ce5e99a451a6868b;hp=5810d06b98733a2c960a13c0ae3b80723482d61f;hpb=7f2c6a9d809ce3f2f17b591e190fc526b70cd8a5;p=esp-idf diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5810d06b98..3a9bd581da 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -21,10 +21,12 @@ Before sending us a Pull Request, please consider this list of points: * 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 `_. +* Is there documentation or examples that go with code contributions? There are additional suggestions for writing good examples in :idf:`examples` readme. * Are comments and documentation written in clear English, with no spelling or grammar errors? +* Example contributions are also welcome. Please check the :doc:`creating-examples` guide for these. + * 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. @@ -43,5 +45,14 @@ Legal Part Before a contribution can be accepted, you will need to sign our :doc:`contributor-agreement`. You will be prompted for this automatically as part of the Pull Request process. +Related Documents +----------------- +.. toctree:: + :maxdepth: 1 + style-guide + documenting-code + creating-examples + ../api-reference/template + contributor-agreement