Update github issue templates

exasol · Oct 9, 2023 · 40eb15a · 40eb15a
1 parent dcd4ae5
commit 40eb15a
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 38 deletions.
diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md
@@ -0,0 +1,8 @@
+---
+name: 📝 Blank Issue 
+about: Blank Issue
+title: 📝 <Insert Title>
+labels: 
+assignees: ''
+
+---
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -1,7 +1,7 @@
 ---
-name: 🐞 Bug Report 
-about: File a bug report 
-title: 🐞 <Insert Title> 
+name: 🐞 Bug Report
+about: File a bug report
+title: 🐞 <Insert Title>
 labels: bug
 assignees: ''
 
@@ -11,17 +11,16 @@ assignees: ''
 In order to improve the time, how long a bugfix does take, please make sure you address as much as possible of the following checklist.
 
 - [ ] I have reproduced the issue with at least the latest released version of \<PROJECT-NAME\>.
-- [ ] I have added references to issues that sound similar.
+- [ ] I have added references to issues that sound similar in section _Related Issues_.
 
-**Tip: Adding screenshots, outputs and logs help to improve clarity.**
+**Tip: Adding screenshots, outputs and logs might help to improve clarity.**
 
 # Summary
 <!---
 Describe the bug: A clear and concise description of what the bug is.
 -->
 
 ## Reproducing the Issue
-
 Reproducibility: <pick one of> sporadic, regularly, always
 <!---
 Describe how to reproduce the bug, e.g.:
@@ -31,7 +30,7 @@ Describe how to reproduce the bug, e.g.:
 4. See error
 -->
 ### Steps to reproduce the behavior:
-1. <step 1> 
+1. <step 1>
 2. <step 2>
 3. ....
 
@@ -42,8 +41,8 @@ Describe the expected behaviour: A clear and concise description of what you exp
 
 ## Actual Behaviour
 <!---
-Describe the actual observed behaviour: A clear and concise description of what you actually to happen.
-Screenshot: If applicable, add screenshots to help explain your problem.
+Describe the actual observed behaviour: A clear and concise description of what actually happened.
+Screenshot: If applicable, add screenshots to help explaining your problem.
 -->
 
 ## Root Cause (optional)
@@ -55,7 +54,7 @@ If known
 ## Context
 <!---
 Describe the actual observed behaviour: A clear and concise description of what you observed.
-Screenshot: If applicable, add screenshots to help explain your problem.
+Screenshot: If applicable, add screenshots to help explaining your problem.
 -->
 
 ### System

diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
@@ -1,5 +1,5 @@
 ---
-name: 📚 Documentation 
+name: 📚 Documentation
 about: Add/Improve Documentation
 title: 📚 <Insert Title>
 labels: documentation
@@ -14,7 +14,7 @@ A short summary on what of what needs to be documented or updated.
 
 # Details
 <!---
-A detailed description about what kind of documentation should be added and/or updated and why.
+A detailed description about what kind of documentation should be added and/or updated.
 --->
 
 ## Background & Context
@@ -31,7 +31,7 @@ Further references to e.g. other information resources like links to specificati
 
 # Task(s)
 <!---
-A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+A task list containing common tasks associated with this kind of issue, but also tasks specific to this issue.
 
 e.g.:
 - [ ] Update documentation of XYZ

diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
@@ -36,10 +36,10 @@ Further references to e.g. other information resources like links to specificati
 
 # Task(s)
 <!---
-A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+A task list containing common tasks associated with this kind of issue, but also tasks specific to this issue.
 
 e.g.:
-- [ ] Refactor XYZ
+- [ ] Add feature XYZ
 - [ ] Bump version number
 - [ ] Update documentation
 - [ ] Update changelog

diff --git a/.github/ISSUE_TEMPLATE/refactoring.md b/.github/ISSUE_TEMPLATE/refactoring.md
@@ -1,6 +1,6 @@
 ---
 name: 🔧 Refactoring
-about: Refactor 
+about: Refactor
 title: 🔧 <Insert Title>
 labels: refactoring
 assignees: ''
@@ -36,10 +36,10 @@ Further references to e.g. other information resources like links to specificati
 
 # Task(s)
 <!---
-A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+A task list containing common tasks associated with this kind of issue, but also tasks specific to this issue.
 
 e.g.:
-- [ ] Implement XYZ
+- [ ] Implement/Refactor XYZ
 - [ ] Add tests for XYZ
 - [ ] Bump version number
 - [ ] Update changelog

diff --git a/.github/ISSUE_TEMPLATE/security.md b/.github/ISSUE_TEMPLATE/security.md
@@ -7,8 +7,8 @@ assignees: ''
 
 ---
 
-# Summary 
-<!--- 
+# Summary
+<!---
 A short summary of the security issue.
 --->
 
@@ -44,7 +44,7 @@ Describe the impact of the vulnerability.
 
 ### References
 <!---
-Links to related issues or other sources like link to CVE. 
+Links to related issues or other sources like link to CVE.
 --->
 
 # Solutions

diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/blank.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/blank.md
@@ -0,0 +1,8 @@
+---
+name: 📝 Blank Issue 
+about: Blank Issue
+title: 📝 <Insert Title>
+labels: 
+assignees: ''
+
+---
diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/bug.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/bug.md
@@ -11,17 +11,16 @@ assignees: ''
 In order to improve the time, how long a bugfix does take, please make sure you address as much as possible of the following checklist.
 
 - [ ] I have reproduced the issue with at least the latest released version of \<PROJECT-NAME\>.
-- [ ] I have added references to issues that sound similar.
+- [ ] I have added references to issues that sound similar in section _Related Issues_.
 
-**Tip: Adding screenshots, outputs and logs help to improve clarity.**
+**Tip: Adding screenshots, outputs and logs might help to improve clarity.**
 
 # Summary
 <!---
 Describe the bug: A clear and concise description of what the bug is.
 -->
 
 ## Reproducing the Issue
-
 Reproducibility: <pick one of> sporadic, regularly, always
 <!---
 Describe how to reproduce the bug, e.g.:
@@ -42,8 +41,8 @@ Describe the expected behaviour: A clear and concise description of what you exp
 
 ## Actual Behaviour
 <!---
-Describe the actual observed behaviour: A clear and concise description of what you actually to happen.
-Screenshot: If applicable, add screenshots to help explain your problem.
+Describe the actual observed behaviour: A clear and concise description of what actually happened.
+Screenshot: If applicable, add screenshots to help explaining your problem.
 -->
 
 ## Root Cause (optional)
@@ -55,7 +54,7 @@ If known
 ## Context
 <!---
 Describe the actual observed behaviour: A clear and concise description of what you observed.
-Screenshot: If applicable, add screenshots to help explain your problem.
+Screenshot: If applicable, add screenshots to help explaining your problem.
 -->
 
 ### System
@@ -75,4 +74,4 @@ Add any additional context about the problem here.
 #### Related Issues (optional)
 <!---
 Link related issues form the issue tracker here.
--->
+-->
diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/documentation.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/documentation.md
@@ -14,7 +14,7 @@ A short summary on what of what needs to be documented or updated.
 
 # Details
 <!---
-A detailed description about what kind of documentation should be added and/or updated and why.
+A detailed description about what kind of documentation should be added and/or updated.
 --->
 
 ## Background & Context
@@ -31,11 +31,11 @@ Further references to e.g. other information resources like links to specificati
 
 # Task(s)
 <!---
-A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+A task list containing common tasks associated with this kind of issue, but also tasks specific to this issue.
 
 e.g.:
 - [ ] Update documentation of XYZ
 - [ ] Bump version number
 - [ ] Update changelog
 - [ ] ...
---->
+--->
diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/feature.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/feature.md
@@ -36,12 +36,12 @@ Further references to e.g. other information resources like links to specificati
 
 # Task(s)
 <!---
-A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+A task list containing common tasks associated with this kind of issue, but also tasks specific to this issue.
 
 e.g.:
-- [ ] Refactor XYZ
+- [ ] Add feature XYZ
 - [ ] Bump version number
 - [ ] Update documentation
 - [ ] Update changelog
 - [ ] ...
---->
+--->
diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/refactoring.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/refactoring.md
@@ -36,12 +36,12 @@ Further references to e.g. other information resources like links to specificati
 
 # Task(s)
 <!---
-A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+A task list containing common tasks associated with this kind of issue, but also tasks specific to this issue.
 
 e.g.:
-- [ ] Implement XYZ
+- [ ] Implement/Refactor XYZ
 - [ ] Add tests for XYZ
 - [ ] Bump version number
 - [ ] Update changelog
 - [ ] ...
---->
+--->
diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/security.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/security.md
@@ -55,4 +55,4 @@ Describe possible solution(s), how to address this issue.
 # Credit
 <!--
 Whom to thank, kudos for the reporter(s)
--->
+-->