-
-
Notifications
You must be signed in to change notification settings - Fork 641
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Templates for issues/pull tracker #99
base: master
Are you sure you want to change the base?
Conversation
QA: Do not merge from master to avoid conflicting commits |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added labels and default assignees
docs/bug_report.md
Outdated
@@ -1,4 +1,5 @@ | |||
--- | |||
title: "BUG: " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Forcing BUG:
prefix for bug format
name: Bug report | ||
about: Create a report to help us improve | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reworked feature request because i think that this is more effective
Review from @nntoan @rpotter12 is requested |
@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 |
fixes #93