merge github-issue-guide with the issue template #4636
Conversation
ghost
assigned 
Stebalien
force-pushed
the
feat/expand-issue-template
branch
from
9a85ace
to
d92acb8
Compare
|
|
||
| ### Area | ||
|
|
||
| What your issue refers to. Multiple items are OK. |
There was a problem hiding this comment.
This didn't exist on the issue template. Should we put it in? Most users probably won't know enough to fill this out, unfortunately. We usually just use labels.
There was a problem hiding this comment.
It could be useful, but you are right most users won't know enough to fill this out. Users who do likely already have write access and can assign lables, that is if they remember to do so. :)
There was a problem hiding this comment.
That never happens. I have no idea what you're talking about.
There was a problem hiding this comment.
I used to tag issues with subsystem/topic labels. It was endless work and it somehow stopped being important.
| below information, if possible. This will help us triage the issues faster. | ||
| Please title your issues with the type. For instance: | ||
|
|
||
| - "bug: Cannot add file with `ipfs add`" |
There was a problem hiding this comment.
We don't actually do this... Should we start?
There was a problem hiding this comment.
I am not against it, but unless we do it consistently all it will do is add noise.
| - "enhancement ": If you'd like to suggest an improvement on to existing feature. | ||
| - "test failure": If the tests are failing | ||
| - "doc": If it's related to missing/incorrect documentation. | ||
| - "meta": If its a meta issue about this project/this repository/issue tracker. |
There was a problem hiding this comment.
You left out panic, I think that is useful for cases when ipfs crashes or other obvious bug. A panic in my view indicates a programmer error.
There was a problem hiding this comment.
Ah. Good point. Delineates "I think this is a bug" and "this is definitely a bug".
| below information, if possible. This will help us triage the issues faster. | ||
| Please title your issues with the type. For instance: | ||
|
|
||
| - "bug: Cannot add file with `ipfs add`" |
There was a problem hiding this comment.
I am not against it, but unless we do it consistently all it will do is add noise.
|
|
||
| ### Area | ||
|
|
||
| What your issue refers to. Multiple items are OK. |
There was a problem hiding this comment.
It could be useful, but you are right most users won't know enough to fill this out. Users who do likely already have write access and can assign lables, that is if they remember to do so. :)
| <!-- | ||
|
|
||
| - "bug": If what you are filing is a bug. | ||
| - "panic": If you'd like to report an application panic, segfault, crash, etc. |
There was a problem hiding this comment.
I suppose that is a bit more specific than the original description of "If it is a severe bug.", but I think I would use this also when the server dies with an error message when responding to a (perhaps invalid) request from the client.
|
I think the threshold for the codecov/project test needs adjusting. This p.r. doesn't even touch the code. @Kubuxu how about something like 0.5%? |
|
Sorry - should not have been closed. |
|
These seem like positive changes - should I rebase and merge? It sounds like maybe this was held up by coverage? |
|
Molly has heavily edited the issue template since then. But yeah, it would be nice to get some of this information into the template. |
License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
This was present in the issue guide that I just removed but not in the template. It's useful for distinguishing between objective bugs and subjective bugs. License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
eingenito
force-pushed
the
feat/expand-issue-template
branch
from
281e152
to
3099f2f
Compare
|
Refreshed and mergeable if people find it valuable. |
|
Updated this with the instructions Steven and I had workshopped. LGTM |
Redoing the changes Steven and I worked on separately for the top-line instructions. License: MIT Signed-off-by: Molly Mackinlay <molly@protocol.ai>
eingenito
force-pushed
the
feat/expand-issue-template
branch
from
02a5c1d
to
0a6c7c1
Compare
This is one way to address @kevina's feedback about updating the github-issue-guide. This way, we don't have to maintain two documents (one of which most users won't bother to read).
Basically, I pulled (what I considered to be) the relevant information from the issue guide to the template.
Thoughts?