documentation: update labelers and improve issue templates

rero · Feb 28, 2022 · 9572be9 · 9572be9
1 parent 34b5abe
commit 9572be9
Show file tree

Hide file tree

Showing 8 changed files with 134 additions and 183 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,61 +2,49 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: bug, triage
+labels: bug
 assignees: ''
 
 ---
 
-<!--
-    Please, fill the bug report as precisely as possible.
-    Write a full sentence in the issue title.
-    Thanks a lot for helping us!
--->
+<!-- Please, fill the report as precisely as possible.
+Be clear and concise. Write a full sentence in the issue title.
+Thanks for your help! -->
 
-**Describe the bug**
+### Bug description:
+<!-- A concise description of the bug you are experiencing -->
 
-<!--
-    A clear and concise description of what the bug is.
--->
+### Expected behavior:
+<!-- A concise description of what you expected to happen -->
 
-**To Reproduce**
+### Steps to Reproduce:
+<!-- Example: Steps to reproduce the problem:
+1. Go to...
+2. Click on...
+3. Scroll down to...
+4. See error -->
 
-<!--
-    Steps to reproduce the behavior:
--->
+### Context
+<!-- In which environment did the problem occur? -->
 
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+**Server:**
+* [ ] production: [bib.rero.ch](https://bib.rero.ch) or [ils.bib.uclouvain.be](https://ils.bib.uclouvain.be)
+* [ ] test: [bib.test.rero.ch](https://bib.test.rero.ch)
+* [ ] dev: [ilsdev.test.rero.ch](https://ilsdev.test.rero.ch)
+* [ ] dev test : [ils.test.rero.ch](https://ils.test.rero.ch)
 
-**Expected behavior**
+**Version:**
+<!-- In which version of RERO ILS did this problem happen? -->
 
-<!--
-    A clear and concise description of what you expected to happen.
--->
+`v1.9.0` ; commit hash : `XXXX`
 
-**Context**
+**Browser:**
+<!-- If relevant -->
 
-<!--
-    Tell us on what server did you spotted the issue, using which browser:
--->
+Chrome, Safari, Firefox; version XX
 
-* server: [ils.test.rero.ch][1] or [ilsdev.test.rero.ch][2]?
-* version: `v0.14.0` or the commit hash (see frontpage).
-* browser: [if relevant, e.g. chrome, safari, version 78].
+### Screenshots
+<!-- If relevant, screenshots to help ilustrate the problem -->
 
-[1]: https://ils.test.rero.ch
-[2]: https://ilsdev.test.rero.ch
-
-**Screenshots**
-
-<!--
-    If applicable, add screenshots to help explain your problem.
--->
-
-**Additional context**
-
-<!--
-    Add any other context about the problem here.
--->
+### Anything else?
+<!-- Any other useful information about the problem -->
diff --git a/.github/ISSUE_TEMPLATE/correction.md b/.github/ISSUE_TEMPLATE/correction.md
@@ -2,27 +2,18 @@
 name: Wrong implementation report
 about: A feature is implemented, but doesn't work as expected.
 title: ''
-labels: triage, correction
+labels: 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!
- -->
+<!-- Please, fill the report as precisely as possible.
+Be clear and concise. Write a full sentence in the issue title.
+Thanks for your help! -->
 
-**How it works**
+### How it works
+<!-- A clear and concise description of how the existing feature currently works. Please mention if it involves the public or professional view, 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.
--->
+### Improvement suggestion
+<!-- Explain what is missing, why it is frustrating
+and how this could be improved. -->
diff --git a/.github/ISSUE_TEMPLATE/developers.md b/.github/ISSUE_TEMPLATE/developers.md
@@ -1,26 +1,33 @@
 ---
 name: Developers issue report
-about: Create a report to help us improve
+about: Improvement or correction useful from a developer point of view
 title: ''
-labels: developers, triage
+labels: developers
 assignees: ''
 
 ---
 
-<!--
-    Please, fill the bug report as precisely as possible.
-    Write a full sentence in the issue title.
-    Thanks a lot for helping us!
- -->
+<!-- Please, fill the report as precisely as possible.
+Be clear and concise. Write a full sentence in the issue title.
+Thanks for your help! -->
 
-**Describe the issue**
+### Describe the issue
+<!-- A concise description of what the issue is -->
 
-<!--
-    A clear and concise description of what the issue is.
--->
+### What should be done?
 
-**What should be done**
+<!-- A concise description of what has to be done -->
 
-<!--
-    A clear and concise description of what you think has to be done.
--->
+### Context
+<!-- If relevant -->
+
+**Server:**
+* [ ] production: [bib.rero.ch](https://bib.rero.ch) or [ils.bib.uclouvain.be](https://ils.bib.uclouvain.be)
+* [ ] test: [bib.test.rero.ch](https://bib.test.rero.ch)
+* [ ] dev: [ilsdev.test.rero.ch](https://ilsdev.test.rero.ch)
+* [ ] dev test : [ils.test.rero.ch](https://ils.test.rero.ch)
+
+**Version:**
+<!-- In which version of RERO ILS did this problem happen? -->
+
+`v1.9.0` ; commit hash : `XXXX`
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -1,29 +1,19 @@
 ---
-name: Enhancement proposition
+name: Enhancement suggestion
 about: Suggest an improvement on an existing feature.
 title: ''
-labels: triage, enhancement
+labels: 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!
- -->
+<!-- Please, fill the report as precisely as possible.
+Be clear and concise. Write a full sentence in the issue title.
+Thanks for your help! -->
 
-**How it works**
+### How it works
+<!-- A clear and concise description of how the existing feature currently works. Please mention if it involves the public or professional view, 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.
--->
+### Improvement suggestion
+<!-- Explain what is missing, why it is frustrating
+and how this could be improved. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -2,39 +2,26 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: triage, feature_request
+labels: new feature
 assignees: ''
 
 ---
 
-<!--
-    Please, fill the bug report as precisely as possible.
-    Write a full sentence in the issue title.
-    Thanks a lot for helping us!
- -->
+<!-- Please, fill the report as precisely as possible.
+Be clear and concise. Write a full sentence in the issue title.
+Thanks for your help! -->
 
-**Is your feature request related to a problem? Please describe.**
+### Problem description
+<!-- A clear and concise description of what the problem is.
+Example: I'm always frustrated when [...] -->
 
-<!--
-    A clear and concise description of what the problem is.
-    Ex. I'm always frustrated when [...]
--->
+### Missing feature
+<!-- A concise description of a feature 
+that could solve this problem? -->
 
-**Describe the solution you'd like**
+### Alternative solutions
+<!-- Any alternative solutions
+or features you've considered for this. -->
 
-<!--
-    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.
--->
-
-**Additional context**
-
-<!--
-    Add any other context or screenshots about the feature request here.
--->
+### Anything else?
+<!-- Any other context or screenshots about the feature request -->
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -2,45 +2,40 @@
 name: Question
 about: Ask a question or for help
 title: 'Write a full question: Why should I have to log in to make a request?'
-labels: question, triage
+labels: question
 assignees: ''
 
 ---
 
-<!--
-    Please, fill the bug report as precisely as possible.
-    Write a full sentence in the issue title.
-    Thanks a lot for helping us!
- -->
+<!-- Please, fill the report as precisely as possible.
+Be clear and concise. Write a full sentence in the issue title.
+Thanks for your help! -->
 
-**Describe your question**
+### Describe your question
+<!-- What are you trying to do? 
+What surprised you in the way RERO ILS is functioning? -->
 
-<!--
-    What are you trying to do? What surprised you in the way RERO ILS
-    is functioning?
--->
+### Context
+<!-- In which environment did the problem occur? -->
 
-**Context**
+**Server:**
+* [ ] production: [bib.rero.ch](https://bib.rero.ch) or [ils.bib.uclouvain.be](https://ils.bib.uclouvain.be)
+* [ ] test: [bib.test.rero.ch](https://bib.test.rero.ch)
+* [ ] dev: [ilsdev.test.rero.ch](https://ilsdev.test.rero.ch)
+* [ ] dev test : [ils.test.rero.ch](https://ils.test.rero.ch)
 
-<!--
-    Tell us on which server the question relates to.
--->
+**Version:**
+<!-- In which version of RERO ILS did this problem happen? -->
 
-* server: [ils.test.rero.ch][1] or [ilsdev.test.rero.ch][2]?
-* version: `v0.14.0` or the commit hash (see frontpage).
-* browser: [if relevant, e.g. chrome, safari, version 78]
+`v1.9.0` ; commit hash : `XXXX`
 
-[1]: https://ils.test.rero.ch
-[2]: https://ilsdev.test.rero.ch
+**Browser:**
+<!-- If relevant -->
 
-**Screenshots**
+Chrome, Safari, Firefox; version XX
 
-<!--
-    If applicable, add screenshots to help explain your problem.
--->
+### Screenshots
+<!-- If relevant, screenshots to help ilustrate the problem -->
 
-**Additional context**
-
-<!--
-    Add any other context about the problem here.
--->
+### Anything else?
+<!-- Any other useful information about the problem -->