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

24 lines
726 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
Improve GitHub templates (#44455) * Improve GitHub templates The existing templates are basically a copy for each type of issue (bug, feature, doc) whereas we can make the template more specific to the task at hand. This PR includes: - More specific sections depending on the type of issue - More concise and direct instructions (NO NEED FOR FRUSTRATION CAPS!) - Single-line comments (no need to guide people to avoid wrong edits) - Improved paste area - Better headings/titles - No 'Summary' title for PRs (so commit information is placed correctly) This PR would require some improvements to Ansibot. * Remove controversial Ansibot stuff Make it easier to get the first batch merged. * Restore ISSUE_TEMPLATE.md * Incorporate reviewer suggestions * Make OS / ENVIRONMENT doc-related * Rephrase Ansibot-related message
2018-09-04 15:31:45 +00:00
<!--- Describe the change below, including rationale and design decisions -->
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
Improve GitHub templates (#44455) * Improve GitHub templates The existing templates are basically a copy for each type of issue (bug, feature, doc) whereas we can make the template more specific to the task at hand. This PR includes: - More specific sections depending on the type of issue - More concise and direct instructions (NO NEED FOR FRUSTRATION CAPS!) - Single-line comments (no need to guide people to avoid wrong edits) - Improved paste area - Better headings/titles - No 'Summary' title for PRs (so commit information is placed correctly) This PR would require some improvements to Ansibot. * Remove controversial Ansibot stuff Make it easier to get the first batch merged. * Restore ISSUE_TEMPLATE.md * Incorporate reviewer suggestions * Make OS / ENVIRONMENT doc-related * Rephrase Ansibot-related message
2018-09-04 15:31:45 +00:00
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
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
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
Improve GitHub templates (#44455) * Improve GitHub templates The existing templates are basically a copy for each type of issue (bug, feature, doc) whereas we can make the template more specific to the task at hand. This PR includes: - More specific sections depending on the type of issue - More concise and direct instructions (NO NEED FOR FRUSTRATION CAPS!) - Single-line comments (no need to guide people to avoid wrong edits) - Improved paste area - Better headings/titles - No 'Summary' title for PRs (so commit information is placed correctly) This PR would require some improvements to Ansibot. * Remove controversial Ansibot stuff Make it easier to get the first batch merged. * Restore ISSUE_TEMPLATE.md * Incorporate reviewer suggestions * Make OS / ENVIRONMENT doc-related * Rephrase Ansibot-related message
2018-09-04 15:31:45 +00:00
<!--- Pick one below and delete the rest -->
- Bugfix Pull Request
- Docs Pull Request
- Feature Pull Request
- New Module Pull Request
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
Add Component Name to the issue and pr templates (#17019)
2016-08-09 17:18:06 +00:00
##### COMPONENT NAME
Improve GitHub templates (#44455) * Improve GitHub templates The existing templates are basically a copy for each type of issue (bug, feature, doc) whereas we can make the template more specific to the task at hand. This PR includes: - More specific sections depending on the type of issue - More concise and direct instructions (NO NEED FOR FRUSTRATION CAPS!) - Single-line comments (no need to guide people to avoid wrong edits) - Improved paste area - Better headings/titles - No 'Summary' title for PRs (so commit information is placed correctly) This PR would require some improvements to Ansibot. * Remove controversial Ansibot stuff Make it easier to get the first batch merged. * Restore ISSUE_TEMPLATE.md * Incorporate reviewer suggestions * Make OS / ENVIRONMENT doc-related * Rephrase Ansibot-related message
2018-09-04 15:31:45 +00:00
<!--- Write the short name of the module, plugin, task or feature below -->
Add Component Name to the issue and pr templates (#17019)
2016-08-09 17:18:06 +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
Improve GitHub templates (#44455) * Improve GitHub templates The existing templates are basically a copy for each type of issue (bug, feature, doc) whereas we can make the template more specific to the task at hand. This PR includes: - More specific sections depending on the type of issue - More concise and direct instructions (NO NEED FOR FRUSTRATION CAPS!) - Single-line comments (no need to guide people to avoid wrong edits) - Improved paste area - Better headings/titles - No 'Summary' title for PRs (so commit information is placed correctly) This PR would require some improvements to Ansibot. * Remove controversial Ansibot stuff Make it easier to get the first batch merged. * Restore ISSUE_TEMPLATE.md * Incorporate reviewer suggestions * Make OS / ENVIRONMENT doc-related * Rephrase Ansibot-related message
2018-09-04 15:31:45 +00:00
<!--- Include additional information to help people understand the change here -->
<!--- A step-by-step reproduction of the problem is helpful if there is no related issue -->
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 -->
Improve GitHub templates (#44455) * Improve GitHub templates The existing templates are basically a copy for each type of issue (bug, feature, doc) whereas we can make the template more specific to the task at hand. This PR includes: - More specific sections depending on the type of issue - More concise and direct instructions (NO NEED FOR FRUSTRATION CAPS!) - Single-line comments (no need to guide people to avoid wrong edits) - Improved paste area - Better headings/titles - No 'Summary' title for PRs (so commit information is placed correctly) This PR would require some improvements to Ansibot. * Remove controversial Ansibot stuff Make it easier to get the first batch merged. * Restore ISSUE_TEMPLATE.md * Incorporate reviewer suggestions * Make OS / ENVIRONMENT doc-related * Rephrase Ansibot-related message
2018-09-04 15:31:45 +00:00
```paste below
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