From 9932a33c24e9f6efc97bbcd1c2905b237eda2075 Mon Sep 17 00:00:00 2001 From: Pierre Slamich Date: Fri, 16 Jun 2023 12:31:55 +0200 Subject: [PATCH] fix: fix the template of the feature request form (#8404) * fix: fix-template-feature * Update feature_request.yml * fixes --- .github/ISSUE_TEMPLATE/bug_report.yml | 112 ++++++++------------- .github/ISSUE_TEMPLATE/epic.md | 4 +- .github/ISSUE_TEMPLATE/feature_request.yml | 76 ++++++-------- .github/ISSUE_TEMPLATE/story.md | 13 +-- .github/ISSUE_TEMPLATE/task.md | 9 +- 5 files changed, 91 insertions(+), 123 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index dd76fa0cee4d8..8d7ab5a42226a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 +- + +### Steps to reproduce the behavior + +1. Go to '...' +2. Click on '....' +3. … +4. See error + +### Expected behavior +- + +### Why +- + +### Screenshot/Mockup/Before-After + + +### Part of +- #525 + +### Additional context + + +### Type of device + + + +### Number of products impacted + + +### Time per product + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md index c6311739ee8bc..4559de2efc29a 100644 --- a/.github/ISSUE_TEMPLATE/epic.md +++ b/.github/ISSUE_TEMPLATE/epic.md @@ -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: '' --- @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 274578f508bd2..717fac0ca7eda 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 + + +### Proposed solution + + +### Additional context + + +### Code pointers + + +### Number of products impacted + + +### Time per product + + +### Mockups + +### Part of +- #525 + diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md index 1c21adbf96652..592f0760ca848 100644 --- a/.github/ISSUE_TEMPLATE/story.md +++ b/.github/ISSUE_TEMPLATE/story.md @@ -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 - + ### Acceptance criteria @@ -23,5 +21,8 @@ assignees: '' ### Tasks - [ ] Task 1 -- [ ] Task 1 -- [ ] Task 1 +- [ ] Task 2 +- [ ] Task 3 + +### Part of epic +- #525 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md index 5d8060401c2a1..f9bdae8dbe866 100644 --- a/.github/ISSUE_TEMPLATE/task.md +++ b/.github/ISSUE_TEMPLATE/task.md @@ -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 + + +### Part of story +- #525