Update issue templates (#26)

* Update issue templates * Update bug_report.md * Update feature-idea.md * Update bug_report.md * Update .github/ISSUE_TEMPLATE/feature-idea.md Co-authored-by: Henry Wilde <[email protected]> * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: Henry Wilde <[email protected]> * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: Henry Wilde <[email protected]> * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: Henry Wilde <[email protected]> * Apply suggestions from code review Co-authored-by: Henry Wilde <[email protected]> --------- Co-authored-by: Henry Wilde <[email protected]>
datasciencecampus · Mar 27, 2024 · 0e89599 · 0e89599
1 parent 0712860
commit 0e89599
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] : "
+labels: bug
+assignees: ''
+
+---
+
+Please be aware that, as the `pprl_toolkit` is an experimental package, ONS cannot promise to resolve bugs.
+
+### Describe the bug
+A clear and concise description of what the bug is.
+
+### How to reproduce the bug
+Steps to reproduce the behaviour:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected behaviour
+A clear and concise description of what you expected to happen.
+
+### Evidence (tracebacks and screenshots
+If applicable, please add any tracebacks or screenshots to help explain your problem.
+
+### System information
+Please provide the following information about your environment:
+
+ - OS: [e.g. macOS]
+ - Browser (when using the client-side app or GCP): [e.g. Chrome, Safari]
+ - `pprl_toolkit` version: [e.g. 0.0.1]
+
+### Additional context
+Add any other context about the problem here.
+
diff --git a/.github/ISSUE_TEMPLATE/feature-idea.md b/.github/ISSUE_TEMPLATE/feature-idea.md
@@ -0,0 +1,23 @@
+---
+name: Feature idea
+about: Suggest an idea for this project
+title: "[FEATURE] : "
+labels: ''
+assignees: ''
+
+---
+
+Please be aware that, as the `pprl_toolkit` is an experimental package, ONS cannot promise to implement feature ideas.
+
+### Does your feature idea solve a problem?
+If this applies to your idea, please provide a clear and concise description of what the problem is.
+
+### Describe the solution you'd like
+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.
+