esp-idf/docs/en/contribute/index.rst

Contributions Guide
===================

:link_to_translation:`zh_CN:[中文]`

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 <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-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 <copyright-guide>` for additional information.

* Does any new code conform to the ESP-IDF :doc:`Style Guide <style-guide>`?

* Have you installed the :doc:`pre-commit hook <install-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 <https://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit/>`_?

* If you are 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 into 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
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 2022-05-03 17:55:40 -04:00			`Contributions Guide`
			`===================`

docs:Provide CN translation for contribute/index.rst 2023-07-26 22:54:29 -04:00			:link_to_translation:`zh_CN:[中文]`

docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 11:59:44 -04:00			`We welcome contributions to the ESP-IDF project!`
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 2022-05-03 17:55:40 -04:00
			`How to Contribute`
			`-----------------`

docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 11:59:44 -04:00			Contributions to ESP-IDF - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_.
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 2022-05-03 17:55:40 -04:00
			`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 <copyright-guide>` for additional information.

docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 11:59:44 -04:00			* Does any new code conform to the ESP-IDF :doc:`Style Guide <style-guide>`?
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 2022-05-03 17:55:40 -04:00
docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 11:59:44 -04:00			* Have you installed the :doc:`pre-commit hook <install-pre-commit-hook>` for ESP-IDF project?
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 2022-05-03 17:55:40 -04:00
			* 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 <https://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit/>`_?

docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 11:59:44 -04:00			`* If you are unsure about any of these points, please open the Pull Request anyhow and then ask us for feedback.`
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 2022-05-03 17:55:40 -04:00
			`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.`

docs:Provide CN translation for contribute/index.rst 2023-07-26 22:54:29 -04:00			`If this process passes, it will be merged into the public GitHub repository.`
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 2022-05-03 17:55:40 -04:00
			`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`