Skip to content

Commit 8eec5f0

Browse files
Jason2866Jason2866
committed
add PR template
1 parent 63fc1b3 commit 8eec5f0

File tree

6 files changed

+267
-3
lines changed

6 files changed

+267
-3
lines changed

‎.github/FUNDING.yml

-1
This file was deleted.

‎.github/ISSUE_TEMPLATE/Bug_report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ about: Create a Report to help us improve
88
This issue template is meant to REPORT pioarduino caused PROBLEMS ONLY
99
1010
Please DO NOT OPEN AN ISSUE:
11-
- If your problem is caused by a wrong or missing boards manifest, ask for help in [pioarduin Support Chat](https://discord.gg/Nutz9crnZr) and provide a PR to solve
11+
- If your problem is caused by a wrong or missing boards manifest, ask for help in [pioarduin Support Chat](https://discord.gg/Nutz9crnZr) and please provide a PR to solve
1212
- If your pioarduino version is not the latest , please update, your issue might be fixed already
13-
- If you have a problems or a general questions with Arduino core, please address it to the [Arduino Support Chat](https://discord.gg/8xY6e9crwv)
13+
- If you have problems or general questions about the Arduino core, please address it to the [Arduino Support Chat](https://discord.gg/8xY6e9crwv)
1414
- If your issue is a flashing issue, please address it to the [pioarduin Support Chat](https://discord.gg/Nutz9crnZr)
1515
- If your issue is a compilation problem, please address it to the [pioarduino Support Chat](https://discord.gg/Nutz9crnZr)
1616
- If your issue has been addressed before (i.e., duplicated issue), please ask in the original issue

‎.github/PULL_REQUEST_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Description:
2+
3+
**Related issue (if applicable):** fixes #<issue number goes here>
4+
5+
## Checklist:
6+
- [ ] The pull request is done against the latest develop branch
7+
- [ ] Only relevant files were touched
8+
- [ ] Only one feature/fix was added per PR, more changes are allowed when changing boards.json
9+
- [ ] I accept the [CLA](https://github.com/pioarduino/platform-espressif32/blob/main/CONTRIBUTING.md#contributor-license-agreement-cla)

‎.github/config.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Configuration for sentiment-bot - https://github.com/behaviorbot/sentiment-bot
2+
3+
# *Required* toxicity threshold between 0 and .99 with the higher numbers being the most toxic
4+
# Anything higher than this threshold will be marked as toxic and commented on
5+
sentimentBotToxicityThreshold: .7
6+
7+
# *Required* Comment to reply with
8+
sentimentBotReplyComment: >
9+
Please be sure to review the code of conduct and be respectful of other users.
10+
11+
# Note: the bot will only work if your repository has a Code of Conduct

‎CONTRIBUTING.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Contributing
2+
3+
**Any contribution helps our team and makes pioarduino better for the entire community!**
4+
5+
Everybody is welcome and invited to contribute to pioarduino Project by:
6+
7+
* Testing newly released features and reporting issues.
8+
* Providing Pull Requests (Features, Proof of Concepts or Fixes)
9+
* Contributing missing documentation for features in our (not yet existing ;-)) documentation
10+
11+
This document describes rules that are in effect for this repository, meant for handling issues by contributors in the issue tracker and PRs.
12+
13+
## Opening New Issues
14+
15+
**Issue tracker is NOT a general discussion forum!**
16+
1. Opening an issue means that a problem exists in the code and should be addressed by the project contributors.
17+
2. When opening an issue, provide as much as possible infos. The information is important! With insufficient info about the provided issue, the issue may be closed.
18+
3. Questions of type "How do I..." or "Can you please help me with..." WILL NOT be handled here. Such questions should be directed to pioarduino Support Chat. All issues of this type will be closed with a simple reference to this contributing policy.
19+
4. Issues about topics already handled in the documentation will be closed in a similar manner.
20+
5. Issues for unmerged PRs will be closed. If there is an issue with a PR, the explanation should be added to the PR itself.
21+
6. Issues with accompanied investigation that shows the root of the problem should be given priority.
22+
7. Duplicate issues will be closed.
23+
24+
## Triaging of Issues/PR's
25+
26+
1. Any contributor to the project can participate in the triaging process, if he/she/them chooses to do so.
27+
2. An issue that needs to be closed, either due to not complying with this policy, or for other reasons, should be closed by a contributor.
28+
3. Issues that are accepted should be marked with appropriate labels.
29+
4. Issues that could impact functionality for many users should be considered severe.
30+
5. Issues with feature requests should be discussed for viability/desirability.
31+
6. Feature requests or changes that are meant to address a very specific/limited use case, may be denied, or may be required to be redesigned, generalized, or simplified.
32+
7. Feature requests that are not accompanied by a PR:
33+
* could be closed immediately (denied).
34+
* could be closed after some predetermined period of time (left as candidate for somebody to pick up).
35+
8. In some cases, feedback may be requested from the issue reporter, either as additional info for clarification, additional testing, or other. If no feedback is provided, the issue may be closed by a contributor or after 30 days by the STALE bot.
36+
37+
## Pull requests
38+
39+
A Pull Request (PR) is the process where code modifications are managed in GitHub.
40+
41+
The process is straight-forward.
42+
43+
- Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0)
44+
- Fork the pioarduino platform-espressif32 Repository [git repository](https://github.com/pioarduino/platform-espressif32).
45+
- Write/Change the code in your Fork for a new feature, bug fix, optimization, etc.
46+
- Ensure tests work.
47+
- Create a Pull Request against the [**develop**](https://github.com/pioarduino/platform-espressif32/tree/develop) branch of pioarduino.
48+
49+
1. All pull requests must be done against the develop branch.
50+
2. Only relevant files should be touched (Also beware if your editor has auto-formatting feature enabled).
51+
3. Only one feature/fix should be added per PR. A PR for mass changes in boards manifest is allowed.
52+
4. PRs that don't compile (fail in CI Tests) or cause coding errors will not be merged. Please fix the issue. Same goes for PRs that are raised against older commit in develop - you might need to rebase and resolve conflicts.
53+
5. All pull requests should undergo peer review by at least one contributor other than the creator, excepts for the owner.
54+
6. All pull requests should consider updates to the documentation.
55+
7. Pull requests that address an outstanding issue, particularly an issue deemed to be severe, should be given priority.
56+
8. If a PR is accepted, then it should undergo review and updated based on the feedback provided, then merged.
57+
9. By submitting a PR, it is needed to use the provided PR template and check all boxes, performing the required tasks and accepting the CLA.
58+
10. Pull requests that don't meet the above will be denied and closed.
59+
60+
--------------------------------------
61+
62+
## Contributor License Agreement (CLA)
63+
64+
```
65+
By making a contribution to this project, I certify that:
66+
67+
(a) The contribution was created in whole or in part by me and I
68+
have the right to submit it under the GPL-3.0 license; or
69+
70+
(b) The contribution is based upon previous work that, to the best
71+
of my knowledge, is covered under an appropriate open source
72+
license and I have the right under that license to submit that
73+
work with modifications, whether created in whole or in part
74+
by me, under the GPL-3.0 license; or
75+
76+
(c) The contribution was provided directly to me by some other
77+
person who certified (a), (b) or (c) and I have not modified
78+
it.
79+
80+
(d) I understand and agree that this project and the contribution
81+
are public and that a record of the contribution (including all
82+
personal information I submit with it) is maintained indefinitely
83+
and may be redistributed consistent with this project or the open
84+
source license(s) involved.
85+
```
86+
87+
This Contributor License Agreement (CLA) was adopted on April 1st, 2019.
88+
89+
The text of this license is available under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/). It is based on the Linux [Developer Certificate Of Origin](http://elinux.org/Developer_Certificate_Of_Origin), but is modified to explicitly use the GPL-3.0 license and not mention sign-off (due to GitHub.com keeps an historial, with your user name, of PRs' commits and all editions on PR's comments).
90+
91+
To accept the CLA it is required to put a x between [ ] on `[ ] I accept the CLA` in the PR template when submitting it. The [ ] is an opt-in box, so you have to manually accept it.
92+
93+
**Why a CLA ?**
94+
95+
_"A Contributor License Agreement (CLA) is strongly recommended when accepting third party contributions to an open development project, such as an open source software project. In order to redistribute contributions, it is necessary to ensure that the project has the necessary rights to do so. A Contributor License Agreement is a lightweight agreement, signed by the copyright holder, that grants the necessary rights for the contribution to be redistributed as part of the project."_ [OSS Watch](http://oss-watch.ac.uk/resources/cla)
96+
97+
A CLA is a legal document in which you state _you are entitled to contribute the code/documentation/translation to the project_ you’re contributing to and that _you are willing to have it used in distributions and derivative works_. This means that should there be any kind of legal issue in the future as to the origins and ownership of any particular piece of code, then that project has the necessary forms on file from the contributor(s) saying they were permitted to make this contribution.
98+
99+
CLA is a safety because it also ensures that once you have provided a contribution, you cannot try to withdraw permission for its use at a later date. People can therefore use that software, confident that they will not be asked to stop using pieces of the code at a later date.
100+
101+
A __license__ grants "outbound" rights to the user of project.
102+
103+
A __CLA__ enables a contributor to grant "inbound" rights to a project.
104+
105+
106+
107+
108+
109+
<Other>
110+
<A table should be maintained for relating maintainers and components. When triaging, this is essential to figure out if someone in particular should be consulted about specific changes.>
111+
<A stable release cadence should be established, e.g.: every month.>

‎code_of_conduct.md

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official email address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[pioarduino](https://github.com/pioarduino/platform-espressif32/issues/new/choose).
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations
134+

0 commit comments

Comments
 (0)