Creates ISSUE_TEMPLATE.md #218
Conversation
My template proposal for an 'issue template'. Based off of experience at work and https://github.com/maqetta/maqetta/wiki/Severity-and-Priority-of-Issues
ISSUE_TEMPLATE.md
Outdated
| ## Steps to Reproduce Behavior | ||
|
|
||
| ## Issue Severity Classification - Select from: | ||
| ### (1) Severe - Fully impedes usage of `ProjectTemplate`. This condition requires an immediate solution. `ProjectTemplate` is unable to operate or caused other critical software to fail and there is no acceptable way to work around the problem. |
There was a problem hiding this comment.
Could you replace ### (1) with simply 1. (and so on for the other numbers). The text is now marked as headers, which looks pretty bad on the eye.
There was a problem hiding this comment.
Yep, will do. PR to be sent shortly.
ISSUE_TEMPLATE.md
Outdated
| ## Issue Severity Classification - Select from: | ||
| ### (1) Severe - Fully impedes usage of `ProjectTemplate`. This condition requires an immediate solution. `ProjectTemplate` is unable to operate or caused other critical software to fail and there is no acceptable way to work around the problem. | ||
| ### (2) Moderate - Significant impact. `ProjectTemplate` is usable but is limited. Work around exists, but requires significant effort. [Incomplete/incorrect documentation, poor or unexplained log messages where no clear error was evident, side effect is observed which does not significantly harm operations etc] | ||
| ### (3) Low - Minimal impact. Issue is an annoyance, but I can get work done. This indicates the problem causes little impact on operations or that a reasonable circumvention to the problem has been implemented. [Usability quirks, requires minor documentation updates, or could be enhance with some minor changes to the function.] |
There was a problem hiding this comment.
I'm missing an option for feature requests. Those are actually pretty common on this project, and I disagree with https://github.com/maqetta/maqetta/wiki/Severity-and-Priority-of-Issues that enhancement shouldn't be reported this way. Of course a nice PR is preferable, but we can't expect everyone to be able to actually contribute code themselves.
There was a problem hiding this comment.
Yea, we should get something for feature requests too. I'll split the template into "bugs/issues" and "feature requests".
|
@Hugovdberg I've improved the issue template significantly after surveying other templates available on the web. Have a look. |
|
@Hugovdberg Have you accepted the PR already and shall I close this out, then? |
|
Unfortunately I do not have write permissions to the project, so we'll have to wait for @KentonWhite to merge the PR (if he does agree with me your proposal is useful of course). But you have my vote! |
|
Like the template! Quick question: For this PR, why was ProjectTemplate.RProj renamed to ABC.RProj? |
|
Ah. That's my bad. I was experimenting with things for a different feature.
Will fix that and push.
…On Tue, Jan 30, 2018, 11:57 AM Kenton White ***@***.***> wrote:
Like the template! Quick question: For this PR, why was ProjectTemplate
renamed to ABC.RProj?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#218 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AGDNcj5p0-VhmlWmr4wUjaJUxOCF9fLIks5tP3QxgaJpZM4RvVrJ>
.
--
Rahul
|
|
Fixed. Ready for merge. |
* Create ISSUE_TEMPLATE.md My template proposal for an 'issue template'. Based off of experience at work and https://github.com/maqetta/maqetta/wiki/Severity-and-Priority-of-Issues * Improves issue template * Fixes .RProj name
My template proposal for an 'issue template'. Based off of experience at work and https://github.com/maqetta/maqetta/wiki/Severity-and-Priority-of-Issues
Will increase quality of 'issues' raised by users of the project.