Skip to content

Commit dadc101

Browse files
Add files via upload - CONTRIBUTING.rst (espressif#5138)
* Add files via upload Adding of Contributing.rst file. * Update CONTRIBUTING.rst
1 parent 1b2f34b commit dadc101

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

CONTRIBUTING.rst

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Contributions Guide
2+
===================
3+
4+
We welcome contributions to the Arduino ESP32 project!
5+
6+
How to Contribute
7+
-----------------
8+
9+
Contributions to Arduino ESP32 - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests>`_.
10+
11+
Before Contributing
12+
-------------------
13+
14+
Before sending us a Pull Request, please consider this list of points:
15+
16+
* 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.
17+
18+
* Is the code adequately commented for people to understand how it is structured?
19+
20+
* Is there documentation or examples that go with code contributions?
21+
22+
* Are comments and documentation written in clear English, with no spelling or grammar errors?
23+
24+
* Example contributions are also welcome.
25+
26+
* 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/>`_?
27+
28+
* If you're unsure about any of these points, please open the Pull Request anyhow and then ask us for feedback.
29+
30+
Pull Request Process
31+
--------------------
32+
33+
After you open the Pull Request, there will probably be some discussion in the comments field of the request itself.
34+
35+
Once the Pull Request is ready to merge, it will first be merged into our internal git system for in-house automated testing.
36+
37+
If this process passes, it will be merged onto the public github repository.
38+
39+
Legal Part
40+
----------
41+
42+
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.
43+
44+
Related Documents
45+
-----------------
46+
47+
.. toctree::
48+
:maxdepth: 1
49+
50+
contributor-agreement

0 commit comments

Comments
 (0)