]> granicus.if.org Git - esp-idf/blobdiff - CONTRIBUTING.rst
test(spi_master): add performance display for spi master.
[esp-idf] / CONTRIBUTING.rst
index 3bf43f6dbe879e9ce6fed88ab823ddccaff7e9cd..19dde17a9eff689a6d5875f418f282608dc870c2 100644 (file)
@@ -15,11 +15,13 @@ 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 unfortunately cannot accept it.
 
-* Does any new code conform to the esp-idf Style Guide? (Style Guide currently pending).
+* Does any new code conform to the esp-idf :doc:`Style Guide <style-guide>`?
+
+* Does the code documentation follow requirements in :doc:`documenting-code`?
 
 * 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 <https://github.com/espressif/esp-idf/tree/master/examples>`_.
+* 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?
 
@@ -39,6 +41,15 @@ If this process passes, it will be merged onto the public github repository.
 Legal Part
 ----------
 
-Before a contribution can be accepted, you will need to sign our `Contributor Agreement <http://esp-idf.readthedocs.io/en/latest/contributing.html>`_. You will be prompted for this automatically as part of the Pull Request process.
+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
+    ../api-reference/template
+    contributor-agreement
\ No newline at end of file