diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md new file mode 100644 index 000000000..cdd2d6698 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank.md @@ -0,0 +1,8 @@ +--- +name: 📝 Blank Issue +about: Blank Issue +title: 📝 +labels: +assignees: '' + +--- diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 4f6ed4f26..70bfa2a02 100644 --- 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: 🐞 +name: 🐞 Bug Report +about: File a bug report +title: 🐞 labels: bug assignees: '' @@ -11,9 +11,9 @@ 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 \. -- [ ] 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 ## Reproducing the Issue - Reproducibility: sporadic, regularly, always ### Steps to reproduce the behavior: -1. +1. 2. 3. .... @@ -42,8 +41,8 @@ Describe the expected behaviour: A clear and concise description of what you exp ## Actual Behaviour ## Root Cause (optional) @@ -55,7 +54,7 @@ If known ## Context ### System diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index f059cb0f7..a40b4668c 100644 --- 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: 📚 labels: documentation @@ -14,7 +14,7 @@ A short summary on what of what needs to be documented or updated. # Details ## Background & Context @@ -31,7 +31,7 @@ Further references to e.g. other information resources like links to specificati # Task(s) @@ -44,7 +44,7 @@ Describe the impact of the vulnerability. ### References # Solutions diff --git a/doc/changelog.rst b/doc/changelog.rst index 4146d3bc3..38b844d49 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -16,6 +16,7 @@ Unreleased * Changed autogenerated comment in version.py for better clarity * Updated dependencies +* Updated github issue templates .. _changelog-0.4.0: diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/blank.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/blank.md new file mode 100644 index 000000000..cdd2d6698 --- /dev/null +++ b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/blank.md @@ -0,0 +1,8 @@ +--- +name: 📝 Blank Issue +about: Blank Issue +title: 📝 +labels: +assignees: '' + +--- diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/bug.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/bug.md index a44d610a6..70bfa2a02 100644 --- a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/bug.md +++ b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/bug.md @@ -11,9 +11,9 @@ 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 \. -- [ ] 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 ## Reproducing the Issue - Reproducibility: sporadic, regularly, always ## Root Cause (optional) @@ -55,7 +54,7 @@ If known ## Context ### System @@ -75,4 +74,4 @@ Add any additional context about the problem here. #### Related Issues (optional) +--> \ No newline at end of file diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/documentation.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/documentation.md index e19e489c9..a40b4668c 100644 --- 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 ## Background & Context @@ -31,11 +31,11 @@ Further references to e.g. other information resources like links to specificati # Task(s) +---> \ No newline at end of file diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/feature.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/feature.md index 6cfcd2692..6599d541b 100644 --- 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) +---> \ No newline at end of file diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/refactoring.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/refactoring.md index 4dbb11b9a..157aba53c 100644 --- 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) +---> \ No newline at end of file diff --git a/exasol/toolbox/templates/github/ISSUE_TEMPLATE/security.md b/exasol/toolbox/templates/github/ISSUE_TEMPLATE/security.md index 8f95a1624..b2da5b7fc 100644 --- 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 +--> \ No newline at end of file