Update issue templates to be more concise and delete PR template

CrumpetDev · Feb 12, 2024 · fe556a7 · fe556a7
1 parent 67a6644
commit fe556a7
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 123 deletions.
diff --git a/.dictionary/custom.txt b/.dictionary/custom.txt
@@ -1,6 +1,7 @@
 anyio
 ASGI
 asgiref
+behaviour
 biochar
 buttonelement
 celerybeat
@@ -29,6 +30,7 @@ heebo
 htmlcov
 httptools
 idna
+ifneq
 imageelement
 immer
 Intelli
@@ -45,13 +47,15 @@ nosetests
 openapi
 openapitools
 openpyxl
+pathspec
 pgdata
 PIPENV
 platformdirs
 popperjs
 probs
 projectmembership
 projs
+psql
 psycopg
 Puro
 pyca
@@ -61,13 +65,14 @@ pycryptodome
 pyenv
 pyflakes
 pylint
+pyproject
 pytest
 PYTHONDONTWRITEBYTECODE
 PYTHONUNBUFFERED
 pytz
 Qcet
-runserver
 rpds
+runserver
 sdist
 Secur
 selectiongroup
@@ -84,6 +89,7 @@ textelement
 Titherington
 tomli
 tomlkit
+tomtitherington
 Typecheck
 typechecker
 upsert
@@ -102,7 +108,3 @@ xlwt
 xmlfile
 ZIZW
 zustand
-ifneq
-psql
-pathspec
-pyproject
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,55 +4,44 @@ about: Report a bug or a regression.
 title: 'Ex: History breadcrumb is null on first load (Projects page)'
 labels: 'type: bug, type: other'
 assignees: tomtitherington
-
 ---
 
-## Bug Description
+## Bug Description\*
 
-A clear and concise description of what the current behaviour is.
+- _A clear and concise description of the issue._
 
-**Example:** 
-```
-When first loading the 'Project' page, the history breadcrumb is null. 
-```
+## Screenshots / Stack Trace\*
 
-## Screenshots / Stack Trace
-Add screenshots and/or the stack trace to help explain the problem. This is super valuable and helps us better understand what is going on under the hood.
+- _Add screenshots and/or the stack trace to help explain the problem._
+- _This is super valuable and helps us better understand what is going on under the hood._
 
-## Expected Behavior
+## Expected Behavior\*
 
-A clear and concise description of what the expected behaviour is. In the case of a regression, a screenshot of the Figma design might be a good idea.
-
-**Example:** 
-```
-No breadcrumbs should be displayed and the back button should be greyed out.
-```
+- _A clear and concise description of what the expected behaviour is. In the case of a regression, a screenshot of the Figma design might be a good idea._
 
-## To Reproduce
+## To Reproduce\*
 
-Steps to reproduce the behaviour.
+- _Steps to reproduce the behaviour. For example:_
 
-**Example:**
 ```
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 ```
 
-## Device Details
-Please complete the following information:
- - OS: [e.g. MacOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+## Device Details\*
 
-## Additional Context
-Add any other context about the problem here. 
+- _Please complete the following information._
 
-**Example:**
 ```
-- Need to prevent null values in the history stack.
-- I think a null value here means that there is no history.
+- OS: [e.g. MacOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 ```
 
-### 🙏 Thank you for submitting a bug report! Please delete this heading and the examples included in each section before submitting. 💫
+## Additional Context
+
+- _Add any other context about the problem here._
+
+<small>_\*required field._</small>
diff --git a/.github/ISSUE_TEMPLATE/enhancement---chore.md b/.github/ISSUE_TEMPLATE/enhancement---chore.md
@@ -4,34 +4,20 @@ about: Improvements that may not be noticeable to an end user. (i.e. refactors)
 title: 'Ex: Refactor the useAuth hook to use Zustand'
 labels: 'type: chore'
 assignees: ''
-
 ---
 
-## Summary
-*Briefly describe the enhancement or chore.*
-
-## Background
-**Reason for Enhancement:** 
-*Why is this enhancement needed?*
-
-*Example:*
-```
-Currently, we're prop drilling and passing around context. Using Zustand would ...
-```
+## Background & Scope
 
-## Proposed Course of Action
-**Changes:**
-*Detail the proposed changes including code snippets where relevant.*
+- _Describe the reason for the enhancement or chore._
+- _Reference PRs, other issues or commits where relevant._
 
-**Conflicts:** 
-*Will this impact other parts of the code base, require migrations .. etc? Are there dependencies?*
+## Proposed Changes
 
-## Mockups/Examples
-*If applicable, add mockups or examples of the proposed enhancement.*
+- _Describe the proposed changes including code snippets where relevant._
+- _If applicable, add mockups or code examples of the proposed changes._
+- _Mention the dependencies, conflicts or impact this will have on the code base_
+- _Try to use a task list or bullet points._
 
 ## Additional Information
-**Notes:**
-*Any other relevant information.*
 
-**References:** 
-*Links to similar features or relevant discussions.*
+- _Any other relevant information, links ... etc._
diff --git a/.github/ISSUE_TEMPLATE/new-feature---behaviour.md b/.github/ISSUE_TEMPLATE/new-feature---behaviour.md
@@ -4,59 +4,38 @@ about: Describe the desired change to the product.
 title: 'Ex: Ability to save component steps as templates'
 labels: 'type: feature request'
 assignees: ''
-
 ---
 
-## Summary
-*Briefly describe the feature or desired behaviour.*
+## Background & Context\*
 
-## Details
-**Goal (Desired Behaviour):** *What is the desired outcome of this feature/task? Usually best written as "I want to ... "*
+- _Briefly describe the feature or desired behaviour._
+- _Describe the reason for this feature. [What is the job to be done?](https://hbr.org/2016/09/know-your-customers-jobs-to-be-done#:~:text=After%20decades%20of,to%20be%20done.)_
 
-*Example:*
-```
-I want to be able to save component steps and reuse them in different flows.
-```
+## Current Behaviour
 
-**Problem (optional):** *Is this feature request related to a problem? Please add relevant details if so.*
+- _If applicable, describe how this currently works and what the proposed feature would change._
 
-*Example:*
-```
-We have a bunch of custom UI components in our React app and we use them across multiple engagement flows.
-```
-**Current Behaviour:** *If applicable, describe how this currently works and what the proposed feature would change.*
+## Goal\*
 
-*Example:*
-```
-I need to create the same step component when I want to use it in a different engagement flow.
-```
-**Mockups/Examples:** 
+- _What is the desired outcome of this feature/task? Usually best written as "I want to ... "_
+- _Is this feature request related to a problem? Please add relevant details if so._
 
-*If applicable, add any mockups or examples.*
+## Implementation Details\*
 
-## Implementation Details
-**Technical Requirements & Proposed Changes:** *List any technical requirements or constraints. Please list them as a task list or bullets.*
+- _List any technical requirements or constraints. Please list them as a task list or bullets._
+- _Use code snippets where applicable._
 
-*Example:*
-```
-- [ ] Create new 'is_template' field on the Step component model
-- [ ] Add an option to save template in the ComponentDropdownMenu component
-```
-**Dependencies:** 
+## Acceptance Criteria\*
 
-*Are there other tasks or features this is dependent on? If referencing an existing issue/discussion, please use a task list.*
+- _What are the specific, measurable outcomes that indicate the task is completed? Try use a task list of bullet points._
 
-**Acceptance Criteria:** *What are the specific, measurable outcomes that indicate the task is completed?*
+## Dependencies
 
-*Example:*
-```
-- [ ] I should be able to save a component by clicking on the button in the step drop-down menu
-- [ ] I should be able to drag a templated component from the builder menu within the flow editor
-```
+- _Are there other tasks or features this is dependent on?_
 
 ## Additional Information
-**Notes:** *Any other relevant information.*
 
-**References:** *Links to related documents or discussions. Please use a task list.*
+- _Any other relevant information._
+- _If applicable, add any mockups or examples._
 
-### 🙏 Thank you for your feature request - we really appreciate it! Please be sure to remove the examples and this heading before submitting. 💫
+<small>_\*required field._</small>
diff --git a/.github/ISSUE_TEMPLATE/non-technical-task.md b/.github/ISSUE_TEMPLATE/non-technical-task.md
@@ -4,19 +4,15 @@ about: Use this for non-technical work. (i.e. design work, documentation changes
 title: 'Ex: Profile dropdown list component design'
 labels: 'type: other'
 assignees: ''
-
 ---
 
-## Summary
-*Briefly describe the work to be done.*
+## Summary\*
+
+- _Describe the work to be done._
 
-## Details
-- **Deliverables:** *What should be delivered? Go into detail where necessary, this is usually best written as a list of tasks.*
+## Deliverables\*
 
-*Example:* 
-```
-- [ ] Create dropdown as a Figma component
-- [ ] Share the design as a comment on this issue
-```
+- _What should be delivered? Go into detail where necessary, this is usually best written as a list of tasks._
+- _When you've finished the work, please add an attachment (link .. etc) to this issue as a comment._
 
-___When you've finished the work, please add an attachment (link .. etc) to this issue as a comment.___
+<small>_\*required field._</small>
diff --git a/pull_request_template.md b/pull_request_template.md