docs: Templates for issues/pull tracker #99
Conversation
|
QA: Do not merge from master to avoid conflicting commits
|
Kreyren
changed the title
|
Relevant: there is also a gui for this https://help.github.com/en/articles/creating-issue-templates-for-your-repository |
|
Moved in docs, because i believe it's better to organize these documents to be accesible by the community. |
docs/bug_report.md
Outdated
| @@ -1,5 +1,7 @@ | |||
| --- | |||
| name: Bug report | |||
| labels: bug-report "P3 - Normal" | |||
| assignees: kreyren nntoan | |||
There was a problem hiding this comment.
Added labels and default assignees
docs/bug_report.md
Outdated
| @@ -1,4 +1,5 @@ | |||
| --- | |||
| title: "BUG: " | |||
There was a problem hiding this comment.
Forcing BUG: prefix for bug format
| name: Bug report | ||
| about: Create a report to help us improve | ||
|
|
There was a problem hiding this comment.
Added additional space since name and about are displayed in gui where title, labels etc are in issue
docs/bug_report.md
Outdated
| @@ -9,10 +9,6 @@ assignees: kreyren nntoan | |||
|
|
|||
| --- | |||
|
|
|||
| **I'm submitting a ...** (check one with "x") | |||
| - [x] bug report | |||
| - [ ] feature request | |||
There was a problem hiding this comment.
Previous changes should make this format obsolete since we are using labels and BUG: prefix
| @@ -20,7 +20,7 @@ assignees: kreyren nntoan | |||
|
|
|||
|
|
|||
| ### Steps to reproduce it | |||
| <!-- Add steps to reproduce bugs or add information on the place where the feature should be implemented. Add links to a sample deployment or code. --> | |||
| <!-- Add steps to reproduce provided bug, BE VERBOSE! --> | |||
There was a problem hiding this comment.
Forcing verbose since users are usually very strait forward and forget to provide important informations.
TODO? : Asking to make short, but verbose?
| **I'm submitting a ...** (check one with "x") | ||
| - [ ] bug report | ||
| - [x] feature request | ||
| ### Description/Abstract |
There was a problem hiding this comment.
Reworked feature request because i think that this is more effective
|
Review from @nntoan @rpotter12 is requested |
Kreyren
changed the title
|
@Kreyren I like this template too 👍 |
|
Disclaimer: i don't want to touch merge requests since these will be overwritten by git -> use your best judgement for these that are merging using GUI |
|
@nntoan Please review this PR |
|
|
||
| title: "REQUEST: " | ||
| labels: feature-request "P3 - Normal" | ||
| assignees: kreyren nntoan |
There was a problem hiding this comment.
Having all issues assigned to ya'll may get a bit spamming in your inbox. I'd personally recommend against doing this.
| assignees: kreyren nntoan |
There was a problem hiding this comment.
This PR was made by the previous maintainers (they are still maintainers technically, but they became inactive), but I don't have a plan to merge this as is. Maybe I'll pick some parts from this PR someday when I create the templates, but I now don't see the necessity of the templates.
|
|
||
|
|
||
| ### System information: | ||
| <!-- Add information about the system your facing this bug on. If you think this is irrelevant or if it's a UI bug or a feature request, please remove this section --> |
There was a problem hiding this comment.
Is there a omb function we could use to assist users in getting this information? asdf has a asdf info function which outputs...
OS:
Linux Earth 5.15.0-119-generic #129-Ubuntu SMP Fri Aug 2 19:25:20 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux
SHELL:
GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
Copyright (C) 2020 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
BASH VERSION:
5.1.16(1)-release
ASDF VERSION:
v0.14.1
There was a problem hiding this comment.
We recently added a skeleton omb, but no subcommands are implemented. We may check the upstream OMZ to see if they have an implementation of omz info or similar.
There was a problem hiding this comment.
The closest in the upstream seems to be omz version, but this only shows the version of Oh My Zsh.
| name: Bug report | ||
| about: Create a report to help us improve | ||
|
|
||
| title: "BUG: " |
There was a problem hiding this comment.
Prefixing the issue type may not be necessary when the correct label is applied.
| name: Feature request | ||
| about: Suggest an idea for this project | ||
|
|
||
| title: "REQUEST: " |
There was a problem hiding this comment.
As above, when the correct label is applied, I believe prefixing "REQUEST:" to the title adds unneeded distraction.
akinomyoga
added
P5 - Lowest priority
|
I lowered the priority tag to P5. The situation for the maintenance has changed, and I don't have a plan to merge this PR. I keep this PR just to pick some changes later when I create templates someday. Those tags are also a part of the previous attempt at the maintenance, and I currently don't use them. I kept these priority tags since I didn't have a reason to remove them, but I decided to tweak them because they seem to confuse people. |
fixes #93