From 0f515ce3fbb2e94fb9816d7959dddf96e41d7109 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Tue, 3 May 2022 23:55:40 +0200 Subject: [PATCH] docs: make CONTRIBUTING.md readable on Github Move the contents of CONTRIBUTING.rst into contributing/index.rst, create CONTRIBUTING.md with a link to the programming guide. Closes https://github.com/espressif/esp-idf/issues/6807 --- .gitlab/CODEOWNERS | 2 +- CONTRIBUTING.md | 6 ++ CONTRIBUTING.rst | 63 ------------------- docs/en/contribute/contributor-agreement.rst | 10 +-- docs/en/contribute/index.rst | 64 +++++++++++++++++++- 5 files changed, 73 insertions(+), 72 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 CONTRIBUTING.rst diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS index 1df6a2dc28..72448df0e3 100644 --- a/.gitlab/CODEOWNERS +++ b/.gitlab/CODEOWNERS @@ -53,7 +53,7 @@ /.pre-commit-config.yaml @esp-idf-codeowners/ci /.readthedocs.yml @esp-idf-codeowners/docs /CMakeLists.txt @esp-idf-codeowners/build-config -/CONTRIBUTING.rst @esp-idf-codeowners/docs +/CONTRIBUTING.md @esp-idf-codeowners/docs /Kconfig @esp-idf-codeowners/build-config /README*.md @esp-idf-codeowners/docs /add_path.sh @esp-idf-codeowners/tools diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..14018a79b8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing to ESP-IDF + +Contributions to ESP-IDF - fixing bugs, adding features, adding documentation - are welcome! We accept contributions via Github Pull Requests. + +Please see the [Contributions Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/contribute/index.html) for more information. + diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 1c1270f1c7..0000000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,63 +0,0 @@ -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 `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 Apache License 2.0 compatible Open Source License? If not then we unfortunately cannot accept it. Please check the :doc:`Copyright Header Guide ` for additional information. - -* 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 - creating-examples - ../api-reference/template - contributor-agreement - copyright-guide - esp-idf-tests-with-pytest diff --git a/docs/en/contribute/contributor-agreement.rst b/docs/en/contribute/contributor-agreement.rst index 6d9289d7e9..f6f4461d02 100644 --- a/docs/en/contribute/contributor-agreement.rst +++ b/docs/en/contribute/contributor-agreement.rst @@ -1,19 +1,15 @@ Contributor Agreement ===================== -Individual Contributor Non-Exclusive License Agreement ------------------------------------------------------- - -including the Traditional Patent License OPTION ------------------------------------------------ +Individual Contributor Non-Exclusive License Agreement including the Traditional Patent License OPTION +------------------------------------------------------------------------------------------------------ Thank you for your interest in contributing to Espressif IoT Development Framework (esp-idf) ("We" or "Us"). The purpose of this contributor agreement ("Agreement") is to clarify and document the rights granted by contributors to Us. To make this -document effective, please follow the instructions at -:idf_file:`CONTRIBUTING.rst` +document effective, please follow the instructions in the :doc:`index`. 1. DEFINITIONS ~~~~~~~~~~~~~~ diff --git a/docs/en/contribute/index.rst b/docs/en/contribute/index.rst index b1cd2f37dc..1c1270f1c7 100644 --- a/docs/en/contribute/index.rst +++ b/docs/en/contribute/index.rst @@ -1 +1,63 @@ -.. include:: ../../../CONTRIBUTING.rst +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 `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 Apache License 2.0 compatible Open Source License? If not then we unfortunately cannot accept it. Please check the :doc:`Copyright Header Guide ` for additional information. + +* 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 + creating-examples + ../api-reference/template + contributor-agreement + copyright-guide + esp-idf-tests-with-pytest