adds an issue template for the TC repo #3708
Conversation
|
Refer to this link for build results (access rights to CI server needed): |
mitchell852
force-pushed
the
issue-template
branch
2 times, most recently
from
ec48a5c
to
d87573a
Compare
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
mitchell852
force-pushed
the
issue-template
branch
2 times, most recently
from
7e8234d
to
d2059c7
Compare
mitchell852
force-pushed
the
issue-template
branch
from
d2059c7
to
59eb101
Compare
|
Refer to this link for build results (access rights to CI server needed): |
|
retest this please |
|
Refer to this link for build results (access rights to CI server needed): |
ISSUE_TEMPLATE.md
Outdated
| [Traffic Control slack channels](https://traffic-control-cdn.slack.com) or [Traffic Control mailing lists](http://trafficcontrol.apache.org/mailing_lists/). | ||
| - Before submitting, please **SEARCH GITHUB** for a similar issue or PR. --> | ||
|
|
||
| **I'm submitting a ...** |
There was a problem hiding this comment.
These should be section headings, starting with one pound sign (#) per heading level. Presumably the issue name itself will be the top-level heading, so I'd suggest using 2.
ISSUE_TEMPLATE.md
Outdated
| <!-- (check one with "x") --> | ||
| <!--- security vulnerability (STOP!! - see above)--> | ||
| - [ ] bug report | ||
| - [ ] regression from TC 3.x |
There was a problem hiding this comment.
I'd suggest something more like "Something used to work in an older version of Traffic Control, but doesn't anymore (please specify versions)". Otherwise, how do you indicate a regression from 2.x? Or from 4.x once that's been released?
| **I'm submitting a ...** | ||
| <!-- (check one with "x") --> | ||
| <!--- security vulnerability (STOP!! - see above)--> | ||
| - [ ] bug report |
There was a problem hiding this comment.
personally I think the options ought to get less specific as you go down. Consider this scenario: a user notices that Profile Import no longer works in TPv4. They open an issue, and read through the template. "I'm not reporting a security vulnerability... this isn't a support question... check one type of issue I'm opening, okay, got it... ah! bug report, that was easy" and then they move on to the next section.
There was a problem hiding this comment.
open to suggestions. how you would list them? they're supposed to be mutually exclusive.
There was a problem hiding this comment.
i changed them slightly
ISSUE_TEMPLATE.md
Outdated
| - [ ] other <!--(Please do not submit support requests here - see above)--> | ||
|
|
||
| **The following Traffic Control components are affected by this issue ...** | ||
| <!-- (check one with "x") --> |
There was a problem hiding this comment.
IMO this should be "check all that apply"
ISSUE_TEMPLATE.md
Outdated
| - [ ] bug report | ||
| - [ ] regression from TC 3.x | ||
| - [ ] new feature / enhancement request | ||
| - [ ] improvement (functionality exists but it could be improved in some way) |
There was a problem hiding this comment.
Would examples of "improvement" include refactoring, performance fixes, etc? I.e. doesn't really provide new functionality but isn't necessarily a bug fix? If that's the case, maybe we should say "improvement (e.g. refactoring, performance enhancement, etc -- no new functionality)".
There was a problem hiding this comment.
what about?
improvement (usability, performance, tech debt, etc.)
There was a problem hiding this comment.
The current wording sounds good to me
mitchell852
force-pushed
the
issue-template
branch
from
ec13ee3
to
266b68c
Compare
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
There was a problem hiding this comment.
After the changes you made in response to the other comments, I think this is a solid foundation for issues. The "I'm reporting a" section nicely tells maintainers which labels they should apply, which is good. It's not too heavy, but it still guides users to provide a useful amount of information for fixing issues.
What does this PR (Pull Request) do?
This PR adds an issue template to the TC repo to capture additional information when an issue is submitted.
Which Traffic Control components are affected by this PR?
What is the best way to verify this PR?
Render the markdown and read it.
The following criteria are ALL met by this PR