Merge pull request #203 from netbox-community/pull-request-template

Pull Request Template Suggestion
This commit is contained in:
Christian Mäder 2019-12-16 12:16:53 +01:00 committed by GitHub
commit 85065005d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 49 additions and 1 deletions

View File

@ -25,6 +25,8 @@ Please try this means to get help before opening an issue here:
* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/ * On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/
* On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss * On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss
Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough.
--> -->
## Current Behavior ## Current Behavior

View File

@ -24,6 +24,8 @@ Please try this means to get help before opening an issue here:
* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/ * On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/
* On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss * On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss
Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough.
--> -->
## Desired Behavior ## Desired Behavior
@ -33,7 +35,7 @@ Please try this means to get help before opening an issue here:
## Contrast to Current Behavior ## Contrast to Current Behavior
<!-- please describe how the desired behavior is different to the current behavior --> <!-- please describe how the desired behavior is different from the current behavior -->
... ...
## Changes Required ## Changes Required

44
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,44 @@
<!--
Please don't open an issue when submit PR.
But if there is already a related issue, please put it's number here. E.g. #123 or N/A -->
Related Issue:
## New Behavior
<!--
please describe in a few words the behavior your PR implements
-->
...
## Contrast to Current Behavior
<!--
please describe in a few words how the new behavior is different from the current behavior
-->
...
## Discussion: Benefits and Drawbacks
<!--
Please make your case here:
- Why do you think this project and the community will benefit from your proposed change?
- What are the drawbacks of this change?
- Is it backwards-compatible?
- Anything else that you think is relevant to the discussion of this PR.
(No need to write a huge article here. Just a few sentences that give some additional context about the motivations for the change.)
-->
...
## Changes to the Wiki
<!--
If the README.md must be updated, please include the changes in the PR.
If the Wiki must be updated, please make a suggestions below.
-->
...