Commit graph

22 commits

Author SHA1 Message Date
Dag Wieers
3034709df0 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 16:31:45 +01:00
Sam Doran
231c3586bd
Move summary to top for issue template (#40401) 2018-05-21 10:10:20 -04:00
Sviatoslav Sydorenko
c30f46f7c6 Add note about bot to the issue template 2018-04-25 14:00:19 +02:00
John Barker
4e56dcd01a Update Issue & PR templates to make them clearer
Try and reduce people typing in the comments section
2018-04-17 09:52:37 -04:00
Brian Coca
cd235e9eb0 BELOW THIS COMMENT 2018-04-16 13:45:22 -04:00
Brian Coca
70c0875dbc clarify input location 2018-03-15 14:27:39 -04:00
Rvgate
48005da645 There is no master branch in this project (#35773)
Since there is no master branch, best not to mention it in the issue
template to avoid confusion.
2018-02-06 13:37:04 +00:00
Dag Wieers
3db8b75f35
Remove slashes from instructions to avoid confusion 2017-12-15 17:18:31 +01:00
John R Barker
7654195716
Avoid people listing component in comment 2017-12-13 15:47:29 +00:00
Dag Wieers
e76e8aed90
Fix closing tag for COMPONENT NAME, multiline changes 2017-12-13 10:18:37 +01:00
John R Barker
390a17f0eb
Update ISSUE_TEMPLATE.md 2017-11-30 13:19:07 +00:00
Toshio Kuratomi
c82cf791dd Add a code-smell test for smart quotes and remove smart quotes from all files 2017-09-18 16:49:16 -07:00
Brian Coca
83ef5237cd added note about ansible-config to issue template 2017-09-18 12:33:26 -04:00
John R Barker
830ad2351f Ask for Network OS version info (#25958) 2017-06-21 12:55:55 +01:00
Dag Wieers
8a25b2477c Remove the hint to report module issue elsewhere. 2016-12-14 11:30:44 -05:00
Matt Clay
1da20c9716 Clean up issue templates. (#19011)
* Remove legacy GitHub templates.
* Remove references to module repos.
2016-12-08 17:18:30 -05:00
Dag Wieers
947877dcce Try to avoid module-related tickets in the core Ansible project (#17047)
* Try to avoid module-related tickets in the core Ansible project

Since most users still report module-related problems in the Ansible core GitHub project, I added a warning at the top of the template.

Maybe it could help if the various projects would have more specific names ?

 - ansible/ansible  ->  ansible/main (or something even better ?)
 - ansible/ansible-modules-core  ->  ansible/modules-core
 - ansible/ansible-modules-extras  ->  ansible/modules-extras

I am sure someone can come up with perfect names ;-)

* Remove 'module' from the component options

I would prefer to again note that modules should go elsewhere, but don't want to bloat the text too much.
2016-08-11 10:14:27 -04:00
jctanner
df81f1197f Add Component Name to the issue and pr templates (#17019) 2016-08-09 13:18:06 -04:00
Dag Wieers
f9c4fdab40 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 15:37:17 -04:00
Dag Wieers
e4701b12ee One more improvement 2016-03-23 14:00:55 +01:00
Dag Wieers
2e9fc91844 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 13:49:20 +01:00
Dag Wieers
1afa369eec Move the Github issue and pull-request templates to .github
In essence, most people do not need to use the templates directly,
getting them out of the way increases the signal-to-noise ratio of
the root directory. Direct people to what they are looking for.
2016-03-10 13:55:49 +01:00
Renamed from ISSUE_TEMPLATE.md (Browse further)