docs: improve the github issue template for the repo #5350
Conversation
Brocco
force-pushed
the
issue-template
branch
3 times, most recently
from
f05fa34 to
d2b1688
Compare
.github/ISSUE_TEMPLATE.md
Outdated
| - [ ] bug report -> please search issues before submitting | ||
| - [ ] feature request | ||
|
|
||
| <!-- if bug report, otherwise delete --> |
There was a problem hiding this comment.
I think that you should add an additional empty line before this one, check the preview: https://github.com/Brocco/angular-cli/blob/aaa899e2de344f9d6000deac5593cd3c7f15dca2/.github/ISSUE_TEMPLATE.md
.github/ISSUE_TEMPLATE.md
Outdated
| > Please run `ng --version`. If there's nothing outputted, please run in a Terminal: `node --version` and paste the result here: | ||
| <!-- | ||
| Output from: `ng --version`. | ||
| If nothing, output from: `node --version` and include OS details. |
There was a problem hiding this comment.
Also npm --version along with node version.
.github/ISSUE_TEMPLATE.md
Outdated
| ### Repro steps. | ||
| > Was this an app that wasn't created using the CLI? What change did you do on your code? etc. | ||
| <!-- Steps to reproduce this bug. --> |
There was a problem hiding this comment.
Can you replace this with:
<!--
Simple steps to reproduce this bug.
If the issue can be seen with little or no code changes in a brand new project, list the list of commands to reproduce it.
Otherwise, in cases where a fair amount of code needs to be added, please make a new GitHub repo starting with a fresh CLI project to show the issue.
If we can't follow these steps to reproduce the bug, your issue will be closed as non-reproducible.
-->
I ask because I have to write this over and over again.
There was a problem hiding this comment.
I disagree, the point of this exercise is to make the template less intimidating hopefully getting more people to use the template to help us out.
There was a problem hiding this comment.
Ok, I agree that the blurb I asked for is actually fairly intimidating and that's counterproductive.
But I would still like to see some elaboration of what's the kind of repro we're looking for. A lot (and I do mean a lot) of users just put in something like "When I run ng serve I get this error".
And that fits the bill of a simple repro... which is to run ng serve. But for us it's useless. It just results in a issue I mark as 'needs repro' and never have a lot of time to come back to.
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
|
|
||
| <!-- if bug report, otherwise delete --> |
There was a problem hiding this comment.
Not sure if these will have any effect for the target audience of these changes. I think They'll just leave them in. We can remove them later if that's the case.
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| <!-- if feature, otherwise delete --> | ||
| ### Desired functionality. | ||
| <!-- What would like to see implemented? --> |
There was a problem hiding this comment.
Can you also add What is the usecase?.
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
No description provided.