ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity
community.general/.github/PULL_REQUEST_TEMPLATE.md

30 lines
597 B
Markdown
Raw Normal View History

Create a PULL_REQUEST_TEMPLATE Now that Github supports separate issue and PR templates, we can have a separate cut-down version for PRs without all the things we ask for in a new issue. The PR types are also removed from the ISSUE_TEMPLATE.
2016-02-18 04:40:12 +01:00
##### Issue Type:
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 12:15:24 +01:00
<!--- Please pick one and delete the rest: -->
Create a PULL_REQUEST_TEMPLATE Now that Github supports separate issue and PR templates, we can have a separate cut-down version for PRs without all the things we ask for in a new issue. The PR types are also removed from the ISSUE_TEMPLATE.
2016-02-18 04:40:12 +01:00
- Feature Pull Request
- New Module Pull Request
- Bugfix Pull Request
- Docs Pull Request
##### Ansible Version:
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01:00
```
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 12:15:24 +01:00
<!--- Paste verbatim output from “ansible --version” here -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01:00
```
Create a PULL_REQUEST_TEMPLATE Now that Github supports separate issue and PR templates, we can have a separate cut-down version for PRs without all the things we ask for in a new issue. The PR types are also removed from the ISSUE_TEMPLATE.
2016-02-18 04:40:12 +01:00
##### Summary:
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 12:15:24 +01:00
<!--- Please describe the change and the reason for it -->
Create a PULL_REQUEST_TEMPLATE Now that Github supports separate issue and PR templates, we can have a separate cut-down version for PRs without all the things we ask for in a new issue. The PR types are also removed from the ISSUE_TEMPLATE.
2016-02-18 04:40:12 +01:00
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 12:15:24 +01:00
<!---
If you are fixing an existing issue, please include "Fixes #nnn" in your
Create a PULL_REQUEST_TEMPLATE Now that Github supports separate issue and PR templates, we can have a separate cut-down version for PRs without all the things we ask for in a new issue. The PR types are also removed from the ISSUE_TEMPLATE.
2016-02-18 04:40:12 +01:00
commit message and your description; but you should still explain what
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 12:15:24 +01:00
the change does.
-->
Create a PULL_REQUEST_TEMPLATE Now that Github supports separate issue and PR templates, we can have a separate cut-down version for PRs without all the things we ask for in a new issue. The PR types are also removed from the ISSUE_TEMPLATE.
2016-02-18 04:40:12 +01:00
##### Example output:
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01:00
```
Put the advice to the user as comments in the template Most issues include parts of the advice from the template, which adds noise to tickets. E.g. A lot of tickets include the text "Please pick one and delete the rest:" By adding the advice to the user as comments (<!--- comment -->) we achieve two important things: 1. The advice does not end up in the actual issue ticket or pull request 2. It is easier for the user to differentiate its own input and the original advice (And my help them to clean up the advice as well, which in fact is now no longer necessary)
2016-02-23 12:15:24 +01:00
<!-- Paste verbatim command output here if necessary -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 11:41:47 +01:00
```
Copy permalink