0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-03-14 21:22:57 +00:00
Commit graph

7 commits

Author SHA1 Message Date
Tina Luedtke
927696edf3
PRs template: Include user information section ()
##### Summary
<!--
Describe the change in summary section, including rationale and design decisions.
Include "Fixes #nnn" if you are fixing an existing issue.
-->
As @thiagoftsm and @Ferroin suggested: 
We include a list of our PRs in the release notes. However, when you click on a PR as a user, who isn't involved in the day to day business, you might not understand what the PR does. This PR introduces a new section within "Additional information" to provide additional context for our users. 


##### Test Plan

<!--
Provide enough detail so that your reviewer can understand which test cases you
have covered, and recreate them if necessary. If our CI covers sufficient tests, then state which tests cover the change.
-->
N/A

##### Additional Information
<!-- This is usually used to help others understand your
motivation behind this change. A step-by-step reproduction of the problem is
helpful if there is no related issue. -->
The `details` tag renders a dropdown section and the `summary` tag is used to provide a custom heading. 
Please review this PR as source code and not the rendered version. The `details` tag contains a comment with guiding questions on how to write a good `For users` section.

<details> <summary>For users: How does this change affect me?</summary>
  <!--
Describe the PR affects users: 
- Which area of Netdata is affected by the change?
- Can they see the change or is it an under the hood? If they can see it, where?
- How is the user impacted by the change? 
- What are there any benefits of the change? 
-->
</details>
2022-03-23 19:51:42 +00:00
Ilya Mashchenko
d062196637
remove "component" from PR template () 2022-01-18 10:53:30 +03:00
James Mills
9faa03df57
Improve Pull Request template to have a shorter testing section with enhanced instructions ()
* Improve Pull Request tempalte to have a shorter testing section with enhanced instructions

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>

Co-authored-by: Patti Short <35278231+shortpatti@users.noreply.github.com>
2020-03-12 08:02:18 +10:00
Andrew Moss
cc59c2c0b0
Adding testing section to the PR template. () 2020-02-12 17:41:45 +02:00
Joel Hans
1dc32e2c8f
Fix typo in PULL_REQUEST_TEMPLATE () 2020-01-30 19:49:48 -07:00
Paweł Krupa
cc5af8095f
create better issue and PR templates () 2018-11-27 11:08:25 +02:00
Paweł Krupa
ac0f6f4823
add github templates () 2018-10-17 21:23:32 +02:00