From 1903979d52ab519bf7bf6367bbdc909979d63b99 Mon Sep 17 00:00:00 2001 From: James Elliott Date: Mon, 1 May 2023 14:31:56 +1000 Subject: [PATCH] docs: fix issue template (#5349) Signed-off-by: James Elliott --- .github/ISSUE_TEMPLATE/bug-report.yml | 30 ++++++++++--------- .../github_issue_template_bug_report.yml.tmpl | 30 ++++++++++--------- 2 files changed, 32 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 10fda1cca..890192e2d 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -17,10 +17,14 @@ body: 2. Please try to give as much information as possible for us to be able to reproduce the issue and provide a quick fix. 3. Please ensure an issue does not already exist for this potential bug. 4. Please only provide specific versions. Latest is not a version. - 5. Please read the [Troubleshooting](https://www.authelia.com/r/troubleshooting) reference guide: - - Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section. - - If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/troubleshooting#sanitization) section. - 6. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. + 5. Please only report bugs with Authelia itself. Issues which match one of the following criteria should not be reported here but should be a [discussion](https://github.com/authelia/authelia/discussions/new/choose) instead: + - Bugs with third-party software. + - Mistakes in the documentation. + - Potential bugs where it is not somewhat clear that it's a bug with Authelia itself. + 6. Please read the [Troubleshooting](https://www.authelia.com/r/troubleshooting) reference guide: + - Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section. + - If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/troubleshooting#sanitization) section. + 7. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. - type: dropdown id: version attributes: @@ -106,28 +110,28 @@ body: id: description attributes: label: Description - description: Describe the bug + description: Describe the bug. validations: required: true - type: textarea id: reproduction attributes: label: Reproduction - description: Describe how we can reproduce this issue + description: Describe how we can reproduce this issue. validations: required: true - type: textarea id: expectations attributes: label: Expectations - description: Describe the desired or expected results + description: Describe the desired or expected results. validations: required: false - type: textarea id: configuration attributes: label: Configuration (Authelia) - description: Provide a complete configuration file (the template will automatically put this content in a code block) + description: Provide a complete configuration file (the template will automatically put this content in a code block). render: yaml validations: required: false @@ -136,9 +140,7 @@ body: attributes: label: Logs (Authelia) description: | - Provide complete logs with the log level set to debug or trace. Complete means from application start until the - issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/troubleshooting#logs) - section of the troubleshooting guide. + Provide complete logs with the log level set to debug or trace. Complete means from application start until the issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section of the troubleshooting guide. The template will automatically put this content in a code block so you can just paste it. render: shell @@ -148,7 +150,7 @@ body: id: logs-other attributes: label: Logs (Proxy / Application) - description: Provide complete debug logs for the affected proxy and/or application if available and relevant (the template will automatically put this content in a code block) + description: Provide complete debug logs for the affected proxy and/or application if available and relevant (the template will automatically put this content in a code block). render: shell validations: required: false @@ -156,14 +158,14 @@ body: id: documentation attributes: label: Documentation - description: Provide any relevant specification or other documentation if applicable + description: Provide any relevant specification or other documentation if applicable. validations: required: false - type: checkboxes id: checklist attributes: label: Pre-Submission Checklist - description: By submitting this issue confirm all of the following + description: By submitting this issue confirm all of the following. options: - label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) required: true diff --git a/cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl b/cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl index c15625ca4..144b3fc0b 100644 --- a/cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl +++ b/cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl @@ -17,10 +17,14 @@ body: 2. Please try to give as much information as possible for us to be able to reproduce the issue and provide a quick fix. 3. Please ensure an issue does not already exist for this potential bug. 4. Please only provide specific versions. Latest is not a version. - 5. Please read the [Troubleshooting](https://www.authelia.com/r/troubleshooting) reference guide: - - Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section. - - If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/troubleshooting#sanitization) section. - 6. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. + 5. Please only report bugs with Authelia itself. Issues which match one of the following criteria should not be reported here but should be a [discussion](https://github.com/authelia/authelia/discussions/new/choose) instead: + - Bugs with third-party software. + - Mistakes in the documentation. + - Potential bugs where it is not somewhat clear that it's a bug with Authelia itself. + 6. Please read the [Troubleshooting](https://www.authelia.com/r/troubleshooting) reference guide: + - Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section. + - If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/troubleshooting#sanitization) section. + 7. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. - type: dropdown id: version attributes: @@ -68,28 +72,28 @@ body: id: description attributes: label: Description - description: Describe the bug + description: Describe the bug. validations: required: true - type: textarea id: reproduction attributes: label: Reproduction - description: Describe how we can reproduce this issue + description: Describe how we can reproduce this issue. validations: required: true - type: textarea id: expectations attributes: label: Expectations - description: Describe the desired or expected results + description: Describe the desired or expected results. validations: required: false - type: textarea id: configuration attributes: label: Configuration (Authelia) - description: Provide a complete configuration file (the template will automatically put this content in a code block) + description: Provide a complete configuration file (the template will automatically put this content in a code block). render: yaml validations: required: false @@ -98,9 +102,7 @@ body: attributes: label: Logs (Authelia) description: | - Provide complete logs with the log level set to debug or trace. Complete means from application start until the - issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/troubleshooting#logs) - section of the troubleshooting guide. + Provide complete logs with the log level set to debug or trace. Complete means from application start until the issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section of the troubleshooting guide. The template will automatically put this content in a code block so you can just paste it. render: shell @@ -110,7 +112,7 @@ body: id: logs-other attributes: label: Logs (Proxy / Application) - description: Provide complete debug logs for the affected proxy and/or application if available and relevant (the template will automatically put this content in a code block) + description: Provide complete debug logs for the affected proxy and/or application if available and relevant (the template will automatically put this content in a code block). render: shell validations: required: false @@ -118,14 +120,14 @@ body: id: documentation attributes: label: Documentation - description: Provide any relevant specification or other documentation if applicable + description: Provide any relevant specification or other documentation if applicable. validations: required: false - type: checkboxes id: checklist attributes: label: Pre-Submission Checklist - description: By submitting this issue confirm all of the following + description: By submitting this issue confirm all of the following. options: - label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) required: true