From 95b59e838324cef38331eee7cb6585fa32792fc3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vojt=C4=9Bch=20Barto=C5=A1ka?= <76958047+VojtechBartoska@users.noreply.github.com> Date: Fri, 30 Apr 2021 21:43:07 +0200 Subject: [PATCH 1/2] Add files via upload Adding of Contributing.rst file. --- CONTRIBUTING.rst | 62 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000000..8982a1fa418 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,62 @@ +Contributions Guide +=================== + +We welcome contributions to the Arduino ESP32 project! + +How to Contribute +----------------- + +Contributions to Arduino ESP32 - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests `_. + +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 LGPL 2.1 compatible Open Source License? If not then we unfortunately cannot accept it. + +* Does any new code conform to the esp-idf :doc:`Style Guide `? + +* Have you installed the :doc:`pre-commit hook ` for esp-idf project? + +* 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 :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. + +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 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 + install-pre-commit-hook + documenting-code + add-ons-reference + creating-examples + ../api-reference/template + contributor-agreement From 2f8df0bb3edda0f25d3b3ebf669e975845ebb11f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vojt=C4=9Bch=20Barto=C5=A1ka?= <76958047+VojtechBartoska@users.noreply.github.com> Date: Fri, 30 Apr 2021 21:55:05 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.rst --- CONTRIBUTING.rst | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8982a1fa418..0c0d6936474 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -15,19 +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 LGPL 2.1 compatible Open Source License? If not then we unfortunately cannot accept it. -* Does any new code conform to the esp-idf :doc:`Style Guide `? - -* Have you installed the :doc:`pre-commit hook ` for esp-idf project? - -* 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 :idf:`examples` readme. +* 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. Please check the :doc:`creating-examples` guide for these. +* Example contributions are also welcome. * 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 `_? @@ -53,10 +47,4 @@ Related Documents .. toctree:: :maxdepth: 1 - style-guide - install-pre-commit-hook - documenting-code - add-ons-reference - creating-examples - ../api-reference/template - contributor-agreement + contributor-agreement