Skip to content

Commit 063c237

Browse files
devyteigrr
authored andcommitted
Update POLICY.md
Included review feedback from igrr included feedback in PR (typos)
1 parent 23ceb82 commit 063c237

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

POLICY.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,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.
22
# Opening New Issues
3-
1. The issue tracker is precisely that: a tool to track issues in the core code, and not a discussion forum. Opening an issues means that a problem has been found in the core code, and that it should be addressed by a contributor.
3+
1. The issue tracker is precisely that: a tool to track issues in the core code, and not a discussion forum. Opening an issue means that a problem has been found in the core code, and that it should be addressed by a contributor.
44
2. When opening an issue, a template is presented with fields to fill out. The requested information is important. If the template is ignored, or not enough info about the issue is provided, the issue may be closed due to lack of info. Example:
55
* Using WifiMulti and FS crashes with error. Why? (no basic info, no IDE settings, no sketch provided)
66
3. Questions of type "How do I..." or "Can you please help me with..." or "Can the ESP do..." won't be handled here. Such questions should be directed at a discussion forum, like esp8266.com or stackoverflow. All issues of this type will be closed with a simple reference to the policy. Example:
7-
* how do I connect to wifi
7+
* how do I connect to wifi
88
* how do I connect two ESPs
99
* can I send http data over a public network
1010
* my wiring/project/code doesn't work, help!
@@ -15,28 +15,29 @@ This document describes rules that are in effect for this repository, meant for
1515
5. Issues about topics already handled in the documentation will be closed in a similar manner. Example:
1616
* can't flash with error espcomm failed
1717
6. Issues must be provided with a minimalist sketch. Issues with an incomplete sketch, or a huge sketch, will be closed. Maximum effort must be put forth by the person opening the issue to reduce the relevant code that reproduces the issue, so that investigation can be taken up. MCVE is a must.
18-
7. Issues with accompanied investigation that shows the root of the problem should be given priority
19-
8. Duplicate issues will be closed with a reference to the original
18+
7. Issues for unmerged PRs will be closed. If there is an issue with a PR, the explanation should be added to the PR itself.
19+
8. Issues with accompanied investigation that shows the root of the problem should be given priority
20+
9. Duplicate issues will be closed with a reference to the original
2021

2122
# Triaging
2223
1. Any contributor of the project can participate in the triaging process, if he/she chooses to do so
2324
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
2425
3. Issues that are accepted should be marked with appropriate labels, e.g.: component: xyz
25-
4. If an issue is deemed to require specialized knowledge (e.g.: TLS, HTTP parser, SDK integration, etc), contributor(s) relevant to the affected code should be /cc’ed, as this can help grab attention by the right person
26+
4. If an issue is deemed to require specialized knowledge (e.g.: TLS, HTTP parser, SDK integration, etc), contributor(s) relevant to the affected code should be /cc’ed, as this can help grab attention
2627
5. Severe issues should be assigned to the current milestone (i.e.: the next version to be released), or the milestone following. It is ok to push back issues depending on available resources.
2728
6. Issues that could impact functionality for many users should be considered severe.
2829
7. Issues caused by the SDK or chip should not be marked severe, as there usually isn’t much to be done. Common sense should be applied when deciding. Such issues should be documented in a KID (Known Issues Document), possibly on the Wiki, for reference by users. Example:
29-
* ARP issue
30+
* ARP issue
3031
* Extra channel change beacon announced by the SoftAP
31-
* Wakeup ROM bug in the ESP chip
32+
* Wakeup ROM bug in the ESP chip
3233
8. Issues with feature requests should be discussed for viability/desirability. Example:
33-
* Support for new board. If the new board is not widely used, doesn’t have a manufacturer webpage, etc, then it isn’t desirable to support it. If the new board is essentially a duplicate of another, it isn’t desirable to duplicate the existing one.
34+
* Support for new board. If the new board is not widely used, doesn’t have a manufacturer webpage, etc, then it isn’t desirable to support it. If the new board is essentially a duplicate of another, it isn’t desirable to duplicate the existing one.
3435
9. Feature requests or changes that are meant to address a very specific/limited use case, especially if at the expense of increased code complexity, may be denied, or may be required to be redesigned, generalized, or simplified
3536
10. Feature requests that are not accompanied by a PR:
36-
* could be closed immediately (denied)
37-
* could be closed after some predetermined period of time (left as candidate for somebody to pick up)
38-
* could be deemed interesting enough to work on, but without a specific project or target, and hence accumulated in a long-term feature request list. Such feature requests should in general not be targeted for a deadline or release.
39-
11. In some cases, feedback may be requested from the requestor, either as additional info for clarification, additional testing, or other. If no feedback is provided after 30 days, the issue may be closed by a contributor.
37+
* could be closed immediately (denied)
38+
* could be closed after some predetermined period of time (left as candidate for somebody to pick up)
39+
* could be deemed interesting enough to work on, but without a specific project or target, and hence accumulated in a long-term feature request list. Such feature requests will in general not be targeted for a deadline or release.
40+
11. 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 after 30 days, the issue may be closed by a contributor.
4041

4142
# Compatibility
4243
1. Compatibility with the Arduino build system is first priority. Compatibility with PlatformIO and make are also maintained, but are second priority.
@@ -48,14 +49,15 @@ This document describes rules that are in effect for this repository, meant for
4849
4. The core libs are implemented as a wrapper layer over the Espressif SDK. Due to the requirements and limitations imposed by the SDK, there are inherent differences between the behavior of this core and the standard Arduino core (Example: using long delay()s is not allowed here). Compatibility can’t be maintained in such cases, and differences should be clearly documented.
4950

5051
# Pull requests
51-
1. All pull requests should undergo peer review by at least one contributor other than the requestor
52+
1. All pull requests should undergo peer review by at least one contributor other than the creator
5253
2. All pull requests should consider updates to the documentation
53-
3. All pull requests should consider updates to regressions, where possible
54+
3. All pull requests should consider updates to regression tests, where possible
5455
4. Pull requests that address an outstanding issue, particularly an issue deemed to be severe, should be given priority
55-
5. If a feature requests is accepted, the PR should then be updated based on feedback, then merged.
56+
5. If a PR is accepted, then it should undergo review and updated based on the feedback provided, then merged
57+
6. Pull requests that don't meet the above will be denied and closed
5658

5759
# Other
58-
A table should be maintained for relating maintainers and components. When triaging, this is essential to figure out is someone in particular should be consulted about specific changes.
60+
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.
5961

6062
A stable release cadence should be established, e.g.: every 6 months.
6163

0 commit comments

Comments
 (0)