archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve GitHub templates (#44455)

Browse Source 
* 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
pull/45182/head
Dag Wieers 6 years ago committed by John R Barker
parent a6c97f2243
commit 3034709df0
5 changed files with 76 additions and 154 deletions
Show Stats Download Patch File Download Diff File

43
.github/ISSUE_TEMPLATE.md vendored
Unescape Escape View File

@ -1,12 +1,9 @@
<!--- <!--- Verify first that your issue is not already reported on GitHub -->
Verify first that your issue/request is not already reported on GitHub. <!--- Also test if the latest release and devel branch are affected too -->
THIS FORM WILL BE READ BY A MACHINE, COMPLETE ALL SECTIONS AS DESCRIBED. <!--- Complete *all* sections as described, this form is processed automatically -->
Also test if the latest release, and devel branch are affected too.
ALWAYS add information AFTER (OUTSIDE) these html comments.
Otherwise it may end up being automatically closed by our bot. -->
##### SUMMARY ##### SUMMARY
<!--- Explain the problem briefly --> <!--- Explain the problem briefly below -->
##### ISSUE TYPE ##### ISSUE TYPE
<!--- Pick one below and delete the rest --> <!--- Pick one below and delete the rest -->
@ -15,44 +12,40 @@ Otherwise it may end up being automatically closed by our bot. -->
- Documentation Report - Documentation Report
##### COMPONENT NAME ##### COMPONENT NAME
<!--- Insert, BELOW THIS COMMENT, the name of the module, plugin, task or feature. <!--- Write the short name of the module, plugin, task or feature below -->
Do not include extra details here, e.g. "vyos_command" not "the network module vyos_command" or the full path-->
##### ANSIBLE VERSION ##### ANSIBLE VERSION
<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes below --> <!--- Paste verbatim output from "ansible --version" between quotes -->
``` ```paste below
``` ```
##### CONFIGURATION ##### CONFIGURATION
<!--- If using Ansible 2.4 or above, paste, BELOW THIS COMMENT, the results of "ansible-config dump --only-changed" <!--- Paste verbatim output from "ansible-config dump --only-changed" between quotes -->
Otherwise, mention any settings you have changed/added/removed in ansible.cfg ```paste below
(or using the ANSIBLE_* environment variables).-->
```
##### OS / ENVIRONMENT ##### OS / ENVIRONMENT
<!--- Mention, BELOW THIS COMMENT, the OS you are running Ansible from, and the OS you are <!--- Provide all relevant information below, e.g. target OS versions, network device firmware, etc. -->
managing, or say "N/A" for anything that is not platform-specific.
Also mention the specific version of what you are trying to control,
e.g. if this is a network bug the version of firmware on the network device.-->
##### STEPS TO REPRODUCE ##### STEPS TO REPRODUCE
<!--- For bugs, show exactly how to reproduce the problem, using a minimal test-case. <!--- Describe exactly how to reproduce the problem, using a minimal test-case -->
For new features, show how the feature would be used. -->
<!--- Paste example playbooks or commands between quotes below --> <!--- Paste example playbooks or commands between quotes below -->
```yaml ```yaml
``` ```
<!--- You can also paste gist.github.com links for larger files --> <!--- HINT: You can paste gist.github.com links for larger files -->
##### EXPECTED RESULTS ##### EXPECTED RESULTS
<!--- What did you expect to happen when running the steps above? --> <!--- Describe what you expected to happen when running the steps above -->
##### ACTUAL RESULTS ##### ACTUAL RESULTS
<!--- What actually happened? If possible run with extra verbosity (-vvvv) --> <!--- Describe what actually happened. If possible run with extra verbosity (-vvvv) -->
<!--- Paste verbatim command output between quotes below --> <!--- Paste verbatim command output between quotes -->
``` ```paste below
``` ```

48
.github/ISSUE_TEMPLATE/bug_report.md vendored
Unescape Escape View File

@ -1,61 +1,53 @@
--- ---
name: 🐛 Bug report name: 🐛 Bug report
about: Create a report to help us improve about: Create a report to help us improve
--- ---
<!--- Verify first that your issue is not already reported on GitHub -->
<!--- <!--- Also test if the latest release and devel branch are affected too -->
Verify first that your issue/request is not already reported on GitHub. <!--- Complete *all* sections as described, this form is processed automatically -->
THIS FORM WILL BE READ BY A MACHINE, COMPLETE ALL SECTIONS AS DESCRIBED.
Also test if the latest release, and devel branch are affected too.
ALWAYS add information AFTER (OUTSIDE) these html comments.
Otherwise it may end up being automatically closed by our bot. -->
##### SUMMARY ##### SUMMARY
<!--- Explain the problem briefly --> <!--- Explain the problem briefly below -->
##### ISSUE TYPE ##### ISSUE TYPE
- Bug Report - Bug Report
##### COMPONENT NAME ##### COMPONENT NAME
<!--- Insert, BELOW THIS COMMENT, the name of the module, plugin, task or feature. <!--- Write the short name of the module, plugin, task or feature below -->
Do not include extra details here, e.g. "vyos_command" not "the network module vyos_command" or the full path-->
##### ANSIBLE VERSION ##### ANSIBLE VERSION
<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes below --> <!--- Paste verbatim output from "ansible --version" between quotes -->
``` ```paste below
``` ```
##### CONFIGURATION ##### CONFIGURATION
<!--- If using Ansible 2.4 or above, paste, BELOW THIS COMMENT, the results of "ansible-config dump --only-changed" <!--- Paste verbatim output from "ansible-config dump --only-changed" between quotes -->
Otherwise, mention any settings you have changed/added/removed in ansible.cfg ```paste below
(or using the ANSIBLE_* environment variables).-->
```
##### OS / ENVIRONMENT ##### OS / ENVIRONMENT
<!--- Mention, BELOW THIS COMMENT, the OS you are running Ansible from, and the OS you are <!--- Provide all relevant information below, e.g. target OS versions, network device firmware, etc. -->
managing, or say "N/A" for anything that is not platform-specific.
Also mention the specific version of what you are trying to control,
e.g. if this is a network bug the version of firmware on the network device.-->
##### STEPS TO REPRODUCE ##### STEPS TO REPRODUCE
<!--- For bugs, show exactly how to reproduce the problem, using a minimal test-case. <!--- Describe exactly how to reproduce the problem, using a minimal test-case -->
For new features, show how the feature would be used. -->
<!--- Paste example playbooks or commands between quotes below --> <!--- Paste example playbooks or commands between quotes below -->
```yaml ```yaml
``` ```
<!--- You can also paste gist.github.com links for larger files --> <!--- HINT: You can paste gist.github.com links for larger files -->
##### EXPECTED RESULTS ##### EXPECTED RESULTS
<!--- What did you expect to happen when running the steps above? --> <!--- Describe what you expected to happen when running the steps above -->
##### ACTUAL RESULTS ##### ACTUAL RESULTS
<!--- What actually happened? If possible run with extra verbosity (-vvvv) --> <!--- Describe what actually happened. If possible run with extra verbosity (-vvvv) -->
<!--- Paste verbatim command output between quotes below --> <!--- Paste verbatim command output between quotes -->
``` ```paste below
``` ```

57
.github/ISSUE_TEMPLATE/documentation_report.md vendored
Unescape Escape View File

@ -1,61 +1,38 @@
--- ---
name: 📝 Documentation Report name: 📝 Documentation Report
about: Ask us about docs about: Ask us about docs
--- ---
<!--- Verify first that your improvement is not already reported on GitHub -->
<!--- <!--- Also test if the latest release and devel branch are affected too -->
Verify first that your issue/request is not already reported on GitHub. <!--- Complete *all* sections as described, this form is processed automatically -->
THIS FORM WILL BE READ BY A MACHINE, COMPLETE ALL SECTIONS AS DESCRIBED.
Also test if the latest release, and devel branch are affected too.
ALWAYS add information AFTER (OUTSIDE) these html comments.
Otherwise it may end up being automatically closed by our bot. -->
##### SUMMARY ##### SUMMARY
<!--- Explain the problem briefly --> <!--- Explain the problem briefly below, add suggestions to wording or structure -->
<!--- HINT: Did you know the documentation has an "Edit on GitHub" link on every page ? -->
##### ISSUE TYPE ##### ISSUE TYPE
- Documentation Report - Documentation Report
##### COMPONENT NAME ##### COMPONENT NAME
<!--- Insert, BELOW THIS COMMENT, the name of the module, plugin, task or feature. <!--- Write the name of the rst file, module, plugin, task or feature below -->
Do not include extra details here, e.g. "vyos_command" not "the network module vyos_command" or the full path-->
##### ANSIBLE VERSION ##### ANSIBLE VERSION
<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes below --> <!--- Paste verbatim output from "ansible --version" between quotes -->
``` ```paste below
``` ```
##### CONFIGURATION ##### CONFIGURATION
<!--- If using Ansible 2.4 or above, paste, BELOW THIS COMMENT, the results of "ansible-config dump --only-changed" <!--- Paste verbatim output from "ansible-config dump --only-changed" between quotes -->
Otherwise, mention any settings you have changed/added/removed in ansible.cfg ```paste below
(or using the ANSIBLE_* environment variables).-->
##### OS / ENVIRONMENT
<!--- Mention, BELOW THIS COMMENT, the OS you are running Ansible from, and the OS you are
managing, or say "N/A" for anything that is not platform-specific.
Also mention the specific version of what you are trying to control,
e.g. if this is a network bug the version of firmware on the network device.-->
##### STEPS TO REPRODUCE
<!--- For bugs, show exactly how to reproduce the problem, using a minimal test-case.
For new features, show how the feature would be used. -->
<!--- Paste example playbooks or commands between quotes below -->
```yaml
``` ```
<!--- You can also paste gist.github.com links for larger files --> ##### OS / ENVIRONMENT
<!--- Provide all relevant information below, e.g. OS version, browser, etc. -->
##### EXPECTED RESULTS
<!--- What did you expect to happen when running the steps above? -->
##### ACTUAL RESULTS
<!--- What actually happened? If possible run with extra verbosity (-vvvv) -->
<!--- Paste verbatim command output between quotes below --> ##### ADDITIONAL INFORMATION
``` <!--- Describe how this improves the documentation, e.g. before/after situation or screenshots -->
``` <!--- HINT: You can paste gist.github.com links for larger files -->

52
.github/ISSUE_TEMPLATE/feature_request.md vendored
Unescape Escape View File

@ -1,61 +1,25 @@
--- ---
name: ✨ Feature request name: ✨ Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
--- ---
<!--- Verify first that your feature was not already discussed on GitHub -->
<!--- <!--- Complete *all* sections as described, this form is processed automatically -->
Verify first that your issue/request is not already reported on GitHub.
THIS FORM WILL BE READ BY A MACHINE, COMPLETE ALL SECTIONS AS DESCRIBED.
Also test if the latest release, and devel branch are affected too.
ALWAYS add information AFTER (OUTSIDE) these html comments.
Otherwise it may end up being automatically closed by our bot. -->
##### SUMMARY ##### SUMMARY
<!--- Explain the problem briefly --> <!--- Describe the new feature/improvement briefly below -->
##### ISSUE TYPE ##### ISSUE TYPE
- Feature Idea - Feature Idea
##### COMPONENT NAME ##### COMPONENT NAME
<!--- Insert, BELOW THIS COMMENT, the name of the module, plugin, task or feature. <!--- Write the short name of the new feature, module, plugin or task below -->
Do not include extra details here, e.g. "vyos_command" not "the network module vyos_command" or the full path-->
##### ANSIBLE VERSION
<!--- Paste, BELOW THIS COMMENT, verbatim output from "ansible --version" between quotes below -->
```
```
##### CONFIGURATION
<!--- If using Ansible 2.4 or above, paste, BELOW THIS COMMENT, the results of "ansible-config dump --only-changed"
Otherwise, mention any settings you have changed/added/removed in ansible.cfg
(or using the ANSIBLE_* environment variables).-->
##### OS / ENVIRONMENT ##### ADDITIONAL INFORMATION
<!--- Mention, BELOW THIS COMMENT, the OS you are running Ansible from, and the OS you are <!--- Describe how the feature would be used, why it is needed and what it would solve -->
managing, or say "N/A" for anything that is not platform-specific.
Also mention the specific version of what you are trying to control,
e.g. if this is a network bug the version of firmware on the network device.-->
##### STEPS TO REPRODUCE
<!--- For bugs, show exactly how to reproduce the problem, using a minimal test-case.
For new features, show how the feature would be used. -->
<!--- Paste example playbooks or commands between quotes below --> <!--- Paste example playbooks or commands between quotes below -->
```yaml ```yaml
``` ```
<!--- You can also paste gist.github.com links for larger files --> <!--- HINT: You can also paste gist.github.com links for larger files -->
##### EXPECTED RESULTS
<!--- What did you expect to happen when running the steps above? -->
##### ACTUAL RESULTS
<!--- What actually happened? If possible run with extra verbosity (-vvvv) -->
<!--- Paste verbatim command output between quotes below -->
```
```

30
.github/PULL_REQUEST_TEMPLATE.md vendored
Unescape Escape View File

@ -1,33 +1,29 @@
##### SUMMARY ##### SUMMARY
<!--- Describe the change, including rationale and design decisions --> <!--- Describe the change below, including rationale and design decisions -->
<!--- If you are fixing an existing issue, please include "Fixes #nnn" in your <!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
commit message and your description; but you should still explain what
the change does.-->
##### ISSUE TYPE ##### ISSUE TYPE
<!--- Pick one below and delete the rest: --> <!--- Pick one below and delete the rest -->
- Feature Pull Request - Bugfix Pull Request
- New Module Pull Request - Docs Pull Request
- Bugfix Pull Request - Feature Pull Request
- Docs Pull Request - New Module Pull Request
##### COMPONENT NAME ##### COMPONENT NAME
<!--- Name of the module, plugin, task or feature --> <!--- Write the short name of the module, plugin, task or feature below -->
##### ANSIBLE VERSION ##### ANSIBLE VERSION
<!--- Paste verbatim output from "ansible --version" between quotes below --> <!--- Paste verbatim output from "ansible --version" between quotes -->
``` ```paste below
``` ```
##### ADDITIONAL INFORMATION ##### ADDITIONAL INFORMATION
<!--- Include additional information to help people understand the change here. <!--- 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 <!--- A step-by-step reproduction of the problem is helpful if there is no related issue -->
of the problem is helpful. -->
<!--- Paste verbatim command output below, e.g. before and after your change --> <!--- Paste verbatim command output below, e.g. before and after your change -->
``` ```paste below
``` ```

Write Preview
Loading…
Cancel
Save