Skip to content

Commit

Permalink
fix: fix the template of the feature request form (#8404)
Browse files Browse the repository at this point in the history
* fix: fix-template-feature

* Update feature_request.yml

* fixes
  • Loading branch information
teolemon authored Jun 16, 2023
1 parent b0de94e commit 9932a33
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 123 deletions.
112 changes: 44 additions & 68 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,71 +1,47 @@
---
name: Bug report
description: Create a report to help us improve
description: Create a report to help us improve the Open Food Facts server, API or web app
labels: ["bug"]
body:
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: To Reproduce
description: What steps can the team take to reproduce the issue?
placeholder: |
Steps to reproduce the behavior:
title: ""
assignees: ""
---

1. Go to '…'
2. Click on '…'
3. Scroll down to '…'
4. See error
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Screenshots
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: dropdown
attributes:
label: Type of device
description: How were you accessing ProductOpener when you experienced the bug?
multiple: false
options:
- Browser
- Data dump (eg. MongoDB, CSV)
- REST-API
- Other
validations:
required: true
- type: input
attributes:
label: Browser version
description: If you were using a browser, please specify the name (ie. Firefox or Safari) and version (eg. 91.0.2).
validations:
required: false
- type: textarea
attributes:
label: Number of products impacted
description: If relevant, number (or estimate) of products impacted by the feature at the time of creation of the issue
validations:
required: false
- type: textarea
attributes:
label: Time per product
description: Estimate of timeloss provoked or saved by the issue, per product
validations:
required: false
### What
- <!-- Describe the issue clearly, please add - after each carriage return to add a bullet point for legibility -->

### Steps to reproduce the behavior
<!-- Please replace this by the actual steps, or delete it if not relevant -->
1. Go to '...'
2. Click on '....'
3. …
4. See error

### Expected behavior
- <!-- A clear and concise description of what you expected to happen. -->

### Why
- <!-- Why it's important, optional, delete if empty -->

### Screenshot/Mockup/Before-After
<!-- Add a screenshot or a mockup to help others visualize the probem or solution, optional, delete if empty -->

### Part of
- #525 <!-- Add the issue number preceded by # (that also allows searching by name for similar issues) -->

### Additional context
<!-- Add any other context or screenshots about the feature request here, delete if empty) -->

### Type of device
<!-- How were you accessing ProductOpener when you experienced the bug? -->
<!--
- Browser: name (ie. Firefox or Safari) and version (eg. 91.0.2)
- Data export (eg. MongoDB, CSV)
- REST-API
- Other
-->

### Number of products impacted
<!-- If relevant, number (or estimate) of products impacted by the feature at the time of creation of the issue -->

### Time per product
<!-- Estimate of timeloss provoked or saved by the issue, per product -->
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Epic
about: Template for epics. Epics group several user stories together into a main piece
of added value.
title: ''
labels: "epic"
labels: "epic"
assignees: ''

---
Expand All @@ -18,4 +18,4 @@ assignees: ''
### Who for

### Part of
- Add the parent issue number preceded by # (that also allows searching by name for similar issues): eg #5529
- #525 <!-- Please remplace 525 by the most specific parent issue possible -->
76 changes: 31 additions & 45 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,48 +1,34 @@
---
name: Feature request
description: Suggest an idea for this project
labels: ["feature"]
body:
- type: textarea
attributes:
label: Problem description
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when […]
validations:
required: true
- type: textarea
attributes:
label: Desired solution
placeholder: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Alternatives you have considered
placeholder: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
attributes:
label: Additional context
placeholder: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: textarea
attributes:
label: Number of products impacted
placeholder: If relevant, number (or estimate) of products impacted by the feature at the time of creation of the issue
validations:
required: false
- type: textarea
attributes:
label: Time per product
placeholder: Estimate of timeloss provoked or saved by the issue, per product
validations:
required: false
- type: textarea
attributes:
label: Code pointers
placeholder: Add any pointers to relevant parts of the code. List of files: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/.github/labeler.yml
validations:
required: false
about: Suggest an idea for this project
title: ''
labels: 'feature'
assignees: ''

---

### Problem
<!-- Please replace me by a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

### Proposed solution
<!-- Please replace me by a clear and concise description of what you want to happen -->

### Additional context
<!-- Please replace me by any other context or screenshots about the feature request here. -->

### Code pointers
<!-- Add any pointers to relevant parts of the code. List of files -> https://github.com/openfoodfacts/openfoodfacts-server/blob/main/.github/labeler.yml -->

### Number of products impacted
<!-- If relevant, number (or estimate) of products impacted by the feature at the time of creation of the issue -->

### Time per product
<!-- Estimate of timeloss provoked or saved by the issue, per product -->

### Mockups

### Part of
- #525 <!-- Please remplace 525 by the most specific parent issue possible -->



13 changes: 7 additions & 6 deletions .github/ISSUE_TEMPLATE/story.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@ name: Story
about: Template for user stories. User stories represent a single increment towards
the product goal and/or an epic.
title: ''
labels: '📝 story'
labels: 'story'
assignees: ''

---

- Epic: #

### Description
<e.g. When tapping on the search box, Carla sees suggestions based on her search history to speed up the search process>
<!-- e.g. When tapping on the search box, Carla sees suggestions based on her search history to speed up the search process -->

### Acceptance criteria

Expand All @@ -23,5 +21,8 @@ assignees: ''

### Tasks
- [ ] Task 1
- [ ] Task 1
- [ ] Task 1
- [ ] Task 2
- [ ] Task 3

### Part of epic
- #525 <!-- Please remplace 525 by the most specific parent issue possible -->
9 changes: 7 additions & 2 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@ name: Task
about: Template for tasks. Tasks are a small unit of work, usually resulting of breaking
down a user story or other bigger items of a sprint backlog.
title: ''
labels: 'task'
labels: 'task'
assignees: ''

---

Story: #
### Task
<!-- Tasks are a small unit of work, usually resulting of breaking
down a user story or other bigger items of a sprint backlog. -->

### Part of story
- #525 <!-- Please remplace 525 by the most specific parent issue possible -->

0 comments on commit 9932a33

Please sign in to comment.