-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
documentation: improve issues templates
* Removes the pre filled title, as users often forget to change it. * Adds the missing reference for links. * Puts the instructions in HTML comments in order to prevent them to be displayed after the issue creation. Co-Authored-by: Igor Milhit <[email protected]>
- Loading branch information
iGor milhit
committed
Nov 25, 2020
1 parent
306b77c
commit 038bb1b
Showing
6 changed files
with
129 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,62 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Create a report to help us improve | ||
| title: 'Write a full sentence: The edit button should not be activated for not logged in users.' | ||
| title: '' | ||
| labels: bug, triage | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **Please, fill the bug report as precisely as possible, and remove unused | ||
| sections. Thanks a lot for helping us!** | ||
| <!-- | ||
| Please, fill the bug report as precisely as possible. | ||
| Write a full sentence in the issue title. | ||
| Thanks a lot for helping us! | ||
| --> | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| <!-- | ||
| A clear and concise description of what the bug is. | ||
| --> | ||
|
|
||
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
|
|
||
| <!-- | ||
| Steps to reproduce the behavior: | ||
| --> | ||
|
|
||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
|
|
||
| **Expected behavior** | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| <!-- | ||
| A clear and concise description of what you expected to happen. | ||
| --> | ||
|
|
||
| **Context** | ||
| Tell us on what server did you spotted the issue, using with browser. | ||
|
|
||
| <!-- | ||
| Tell us on what server did you spotted the issue, using which browser: | ||
| --> | ||
|
|
||
| * server: [ils.test.rero.ch][1] or [ilsdev.test.rero.ch][2]? | ||
| * version: *Check the version on homepage*. Do you see the version | ||
| number such as `0.5.0` or a hash such as `2493ca6`? | ||
| * browser: [if relevant, e.g. chrome, safari, version 78] | ||
| * version: `v0.14.0` or the commit hash (see frontpage). | ||
| * browser: [if relevant, e.g. chrome, safari, version 78]. | ||
|
|
||
| [1]: https://ils.test.rero.ch | ||
| [2]: https://ilsdev.test.rero.ch | ||
|
|
||
| **Screenshots** | ||
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| <!-- | ||
| If applicable, add screenshots to help explain your problem. | ||
| --> | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. | ||
|
|
||
| <!-- | ||
| Add any other context about the problem here. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,28 @@ | ||
| --- | ||
| name: Wrong implementation report | ||
| about: A feature is implemented, but doesn't work as expected. | ||
| title: 'Write a full sentence: The badge for renewal is not relevant for checked in items.' | ||
| title: '' | ||
| labels: triage, correction | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| <!-- | ||
| Please, fill the bug report as precisely as possible. | ||
| Write a full sentence in the issue title. | ||
| Thanks a lot for helping us! | ||
| --> | ||
|
|
||
| **How it works** | ||
|
|
||
| A clear and concise description of how works the existing feature. Do not | ||
| forget to tell if it's on the public or professional interface, and in which | ||
| section. | ||
| <!-- | ||
| A clear and concise description of how works the existing feature. | ||
| Do not forget to tell if it's on the public or professional interface, | ||
| and in which section. | ||
| --> | ||
|
|
||
| **How it should works** | ||
|
|
||
| Explain what is wrong, or incorrect, and how it should be amended. | ||
| <!-- | ||
| Explain what is wrong, or incorrect, and how it should be amended. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,26 @@ | ||
| --- | ||
| name: Developers issue report | ||
| about: Create a report to help us improve | ||
| title: 'Write a full sentence: This library should be used with this function.' | ||
| title: '' | ||
| labels: developers, triage | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **Please, fill the bug report as precisely as possible, and remove unused | ||
| sections. Thanks a lot for helping us!** | ||
| <!-- | ||
| Please, fill the bug report as precisely as possible. | ||
| Write a full sentence in the issue title. | ||
| Thanks a lot for helping us! | ||
| --> | ||
|
|
||
| **Describe the issue** | ||
|
|
||
| A clear and concise description of what the issue is. | ||
| <!-- | ||
| A clear and concise description of what the issue is. | ||
| --> | ||
|
|
||
| **What should be done** | ||
|
|
||
| A clear and concise description of what you think has to be done. | ||
| <!-- | ||
| A clear and concise description of what you think has to be done. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,29 @@ | ||
| --- | ||
| name: Enhancement proposition | ||
| about: Suggest an improvement on an existing feature. | ||
| title: 'Write a full sentence: The language selector menu shoud propose a default value.' | ||
| title: '' | ||
| labels: triage, enhancement | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| <!-- | ||
| Please, fill the bug report as precisely as possible. | ||
| Write a full sentence in the issue title. | ||
| Thanks a lot for helping us! | ||
| --> | ||
|
|
||
| **How it works** | ||
|
|
||
| A clear and concise description of how works the existing feature. Do not | ||
| forget to tell if it's on the public or professional interface, and in which | ||
| section. | ||
| <!-- | ||
| A clear and concise description of how works the existing feature. | ||
| Do not forget to tell if it's on the public or professional interface, | ||
| and in which section. | ||
| --> | ||
|
|
||
| **Improvement suggestion** | ||
| Explain what is missing, why is it frustrating and how this could be | ||
| improved. | ||
|
|
||
| <!-- | ||
| Explain what is missing, why is it frustrating | ||
| and how this could be improved. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,40 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest an idea for this project | ||
| title: 'Write a full sentence: The user should be able to do this.' | ||
| title: '' | ||
| labels: triage, feature_request | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| <!-- | ||
| Please, fill the bug report as precisely as possible. | ||
| Write a full sentence in the issue title. | ||
| Thanks a lot for helping us! | ||
| --> | ||
|
|
||
| **Is your feature request related to a problem? Please describe.** | ||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
|
||
| <!-- | ||
| A clear and concise description of what the problem is. | ||
| Ex. I'm always frustrated when [...] | ||
| --> | ||
|
|
||
| **Describe the solution you'd like** | ||
| A clear and concise description of what you want to happen. | ||
|
|
||
| <!-- | ||
| A clear and concise description of what you want to happen. | ||
| --> | ||
|
|
||
| **Describe alternatives you've considered** | ||
| A clear and concise description of any alternative solutions or features you've considered. | ||
|
|
||
| <!-- | ||
| A clear and concise description of any alternative solutions | ||
| or features you've considered. | ||
| --> | ||
|
|
||
| **Additional context** | ||
| Add any other context or screenshots about the feature request here. | ||
|
|
||
| <!-- | ||
| Add any other context or screenshots about the feature request here. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters