wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ansible/.github/PULL_REQUEST_TEMPLATE.md

38 lines
911 B
Markdown
Raw Normal View History

Move summary to be next to where github places the commit message. (#22368) If a user makes a PR with a single, detailed commit message, github will put that at the top of the PR. Move our summary field to the top of the PR template so that it is next to where the commit message is placed. Users can then easily merge the two together or supplement the commit message with additional information that we ask for.
2017-03-07 17:00:22 +00:00
##### SUMMARY
<!--- Describe the change, including rationale and design decisions -->
<!---
If you are fixing an existing issue, please include "Fixes #nnn" in your
commit message and your description; but you should still explain what
the change does.
-->
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests)
2016-03-23 12:49:20 +00:00
##### ISSUE TYPE
<!--- Pick one below 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 03:40:12 +00:00
- Feature Pull Request
- New Module Pull Request
- Bugfix Pull Request
- Docs Pull Request
Add Component Name to the issue and pr templates (#17019)
2016-08-09 17:18:06 +00:00
##### COMPONENT NAME
Remove slashes from instructions to avoid confusion
2017-12-15 16:19:04 +00:00
<!--- Name of the module, plugin, module or task -->
Add Component Name to the issue and pr templates (#17019)
2016-08-09 17:18:06 +00:00
Various improvements to issue/pull-request templates - Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests)
2016-03-23 12:49:20 +00:00
##### ANSIBLE VERSION
Add a code-smell test for smart quotes and remove smart quotes from all files
2017-09-18 17:41:17 +00:00
<!--- Paste verbatim output from "ansible --version" between quotes below -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Move comments out of code-blocks (#15961) In hindsight, I think it is better to have empty code-blocks then comment placeholders when people don't replace those sections.
2016-05-23 19:37:17 +00:00
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00: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 03:40:12 +00:00
Move summary to be next to where github places the commit message. (#22368) If a user makes a PR with a single, detailed commit message, github will put that at the top of the PR. Move our summary field to the top of the PR template so that it is next to where the commit message is placed. Users can then easily merge the two together or supplement the commit message with additional information that we ask for.
2017-03-07 17:00:22 +00:00
##### ADDITIONAL INFORMATION
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 11:15:24 +00:00
<!---
Move summary to be next to where github places the commit message. (#22368) If a user makes a PR with a single, detailed commit message, github will put that at the top of the PR. Move our summary field to the top of the PR template so that it is next to where the commit message is placed. Users can then easily merge the two together or supplement the commit message with additional information that we ask for.
2017-03-07 17:00:22 +00:00
Include additional information to help people understand the change here.
For bugs that don't have a linked bug report, a step-by-step reproduction
of the problem is helpful.
-->
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 03:40:12 +00:00
Move summary to be next to where github places the commit message. (#22368) If a user makes a PR with a single, detailed commit message, github will put that at the top of the PR. Move our summary field to the top of the PR template so that it is next to where the commit message is placed. Users can then easily merge the two together or supplement the commit message with additional information that we ask for.
2017-03-07 17:00:22 +00:00
<!--- Paste verbatim command output below, e.g. before and after your change -->
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Move comments out of code-blocks (#15961) In hindsight, I think it is better to have empty code-blocks then comment placeholders when people don't replace those sections.
2016-05-23 19:37:17 +00:00
Use triple-backticks for verbatim output It's easier than indenting by four spaces, as @willthames points out.
2016-02-18 10:41:47 +00:00
```
Reference in a new issue Copy permalink