From 1e9ba0d0cb69764733e1c19473c76dc7659e989c Mon Sep 17 00:00:00 2001 From: Silke Hofstra Date: Sat, 3 Oct 2020 14:30:59 +0200 Subject: [PATCH] CONTRIBUTING: remove 'feature request' and 'bug reports' sections These have fairly clear templates in the GitHub interface. Duplicating that here servers no purpose. --- CONTRIBUTING.md | 87 +++++++++++++++---------------------------------- 1 file changed, 27 insertions(+), 60 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9589c5a2cc..c19e982341 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,14 +5,13 @@ contribute, and we appreciate all of them. You can jump to the major sections of this document using the following links: * [Getting Started][getting-started] +* [Bug Reports and Feature Requests][issues] +* [General Tips][general-tips] * [Contributing code][contributing-code] * [General Tips][general-tips] -* [Feature Requests][feature-requests] -* [Bug Reports][bug-reports] * [Pull Requests][pull-requests] * [Writing Documentation][writing-documentation] - If you have questions, please send an email to or mailing list or chat on `#riot-os` on [IRC] or [Matrix]. @@ -33,6 +32,31 @@ If you are just beginning to work with RIOT you might first want to read our [documentation]: https://doc.riot-os.org +## Bug reports and feature requests +[issues]: #bug-reports-and-feature-requests +Both bug reports and feature request, big or small, are welcome. + +Before submitting a feature request, please check if an [open issue][existing-feature-request] +already exists. If this is not the case, [submit a feature request][feature-request]. +Describe your use case, why you need this feature and why this feature is important for RIOT. + +Before filing a bug report, please check if an [open issue][existing-bug] +already exists. If this is not the case, [submit a new bug report][bug-report]. +If you're not sure if something is a bug or not, feel free to file a bug report anyway. + +**If you believe reporting your bug publicly represents a security risk to +RIOT users, please send an email describing the bug to **. +We would appreciate waiting for a 6 months grace period before reporting it on +public channels, to allow us adequate time to release the fix. + +[bug reports]: https://github.com/RIOT-OS/RIOT/issues/new?template=bug_report.md +[feature requests]: https://github.com/RIOT-OS/RIOT/issues/new?template=feature_request.md + +[existing-feature-request]: https://github.com/RIOT-OS/RIOT/issues?q=state:open+type:issue+label:"Type:+new+feature" +[feature-request]: https://github.com/RIOT-OS/RIOT/issues/new?template=feature_request.md&title=Feature+Request: +[existing-bug]: https://github.com/RIOT-OS/RIOT/issues?q=state:open+type:issue+label:"Type:+bug" +[bug-report]: https://github.com/RIOT-OS/RIOT/issues/new?template=bug_report.md&title=Bug: + ## General Tips [general-tips]: #general-tips From experience, the following recommendations help to get a software @@ -80,63 +104,6 @@ and got no response. [labels]: https://github.com/RIOT-OS/RIOT/wiki/RIOT%27s-labeling-system [open-a-pull-request]: https://help.github.com/articles/using-pull-requests -## Feature Requests -[feature-requests]: #feature-requests - -Before opening a new feature request, check the -[existing feature requests][existing-feature-request] if there's one already -open on the same topic. - -To request new features or enhancements, just open a new -[feature request issue][new-feature-request]. Describe your use case, why you -need this feature and why this feature is important for RIOT. - -[existing-feature-request]: https://github.com/RIOT-OS/RIOT/issues?q=state:open+type:issue+label:"Type:+new+feature" -[new-feature-request]: https://github.com/RIOT-OS/RIOT/issues/new?template=feature_request.md&title=Feature+Request: - -## Bug Reports -[bug-reports]: #bug-reports - -While bugs are unfortunate, they're a reality in software. We can't fix what we -don't know about, so please report liberally. If you're not sure if something -is a bug or not, feel free to file a bug report anyway. - -**If you believe reporting your bug publicly represents a security risk to -RIOT users, please send an email describing the bug to security@riot-os.org**. -We would appreciate waiting for a 6 months grace period before reporting it on -public channels, to allow us adequate time to release the fix. - -Before reporting a bug, have a look at [open bugs][existing-bugs-link]. Maybe -someone has already reported your error. - -Once you have verified that the bug you have found hasn't been reported, opening an issue is as easy as -clicking on [this link][bug-report-link] and filling out the fields. - -[existing-bugs-link]: https://github.com/RIOT-OS/RIOT/issues?q=state:open+type:issue+label:"Type:+bug" -[bug-report-link]: https://github.com/RIOT-OS/RIOT/issues/new?template=bug_report.md&title=Bug: - -Each bug report issue uses a template with 5 sections that are there to help -other contributors understand your issue and eventually reproduce it: - - #### Description - - #### Steps to reproduce the issue - - #### Expected results - - #### Actual results - - #### Versions - -To fill the `Versions` section, you can use the script provided in the RIOT git -repository: -``` -make print-versions -``` - -In summary, try to include as much information as possible to help maintainers -or other developers fix the bug quickly. - ## Pull Requests [pull-requests]: #pull-requests