docs: adjust issue templates (#4391)

* docs: adjust issue templates

* docs: adjust wording
pull/4392/head
James Elliott 2022-11-16 13:47:20 +11:00 committed by GitHub
parent 261c08118d
commit 13efc4217e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 96 additions and 20 deletions

View File

@ -9,7 +9,7 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for taking the time to fill out this bug report. If you are unsure if this is actually a bug we generally recommend creating a [Question and Answer Discussion](https://github.com/authelia/authelia/discussions/new?category=q-a) first. Thanks for taking the time to fill out this bug report. If you are unsure if this is actually a bug and you still need some form of support we generally recommend creating a [Question and Answer Discussion](https://github.com/authelia/authelia/discussions/new?category=q-a) first.
Please review the following requirements before submitting this issue type: Please review the following requirements before submitting this issue type:
@ -17,7 +17,7 @@ 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. 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. 3. Please ensure an issue does not already exist for this potential bug.
4. Please only provide specific versions. Latest is not a version. 4. Please only provide specific versions. Latest is not a version.
5. Please read the [Troubleshooting Sanitization](https://www.authelia.com/r/sanitize) reference guide if you plan on removing or adjusting any values for the logs or configuration files. 5. Please read the [Troubleshooting Sanitization](https://www.authelia.com/r/sanitize) reference guide if you plan on sanitizing, removing, or adjusting any values for the logs or configuration files.
6. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. 6. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues.
- type: dropdown - type: dropdown
id: version id: version
@ -119,19 +119,27 @@ body:
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: logs id: configuration
attributes: attributes:
label: Logs label: Configuration (Authelia)
description: Provide the logs (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: shell render: yaml
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: configuration id: logs
attributes: attributes:
label: Configuration label: Logs (Authelia)
description: Provide the Authelia configuration file (the template will automatically put this content in a code block) description: Provide complete debug logs (the template will automatically put this content in a code block)
render: yaml render: shell
validations:
required: true
- type: textarea
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)
render: shell
validations: validations:
required: false required: false
- type: textarea - type: textarea
@ -141,4 +149,24 @@ body:
description: Provide any relevant specification or other documentation if applicable description: Provide any relevant specification or other documentation if applicable
validations: validations:
required: false required: false
- type: checkboxes
id: checklist
attributes:
label: Pre-Submission Checklist
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
- label: This is a bug report and not a support request
required: true
- label: I have read the security policy and this bug report is not a security issue or security related issue
required: true
- label: I have either included the complete configuration file or I am sure it's unrelated to the configuration
required: true
- label: I have provided all of the required information in full with the only alteration being reasonable sanitization in accordance with the [Troubleshooting Sanitization](https://www.authelia.com/r/sanitize) reference guide
required: true
- label: I have checked for related proxy or application logs and included them if available
required: true
- label: I have checked for related issues and checked the documentation
required: true
... ...

View File

@ -44,4 +44,14 @@ body:
description: Provide any relevant specification or other documentation if applicable description: Provide any relevant specification or other documentation if applicable
validations: validations:
required: false required: false
- type: checkboxes
id: checklist
attributes:
label: Pre-Submission Checklist
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
- label: I have checked for related issues and checked the documentation
required: true
... ...

View File

@ -9,7 +9,7 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for taking the time to fill out this bug report. If you are unsure if this is actually a bug we generally recommend creating a [Question and Answer Discussion](https://github.com/authelia/authelia/discussions/new?category=q-a) first. Thanks for taking the time to fill out this bug report. If you are unsure if this is actually a bug and you still need some form of support we generally recommend creating a [Question and Answer Discussion](https://github.com/authelia/authelia/discussions/new?category=q-a) first.
Please review the following requirements before submitting this issue type: Please review the following requirements before submitting this issue type:
@ -17,7 +17,7 @@ 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. 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. 3. Please ensure an issue does not already exist for this potential bug.
4. Please only provide specific versions. Latest is not a version. 4. Please only provide specific versions. Latest is not a version.
5. Please read the [Troubleshooting Sanitization](https://www.authelia.com/r/sanitize) reference guide if you plan on removing or adjusting any values for the logs or configuration files. 5. Please read the [Troubleshooting Sanitization](https://www.authelia.com/r/sanitize) reference guide if you plan on sanitizing, removing, or adjusting any values for the logs or configuration files.
6. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. 6. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues.
- type: dropdown - type: dropdown
id: version id: version
@ -84,19 +84,27 @@ body:
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: logs id: configuration
attributes: attributes:
label: Logs label: Configuration (Authelia)
description: Provide the logs (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: shell render: yaml
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: configuration id: logs
attributes: attributes:
label: Configuration label: Logs (Authelia)
description: Provide the Authelia configuration file (the template will automatically put this content in a code block) description: Provide complete debug logs (the template will automatically put this content in a code block)
render: yaml render: shell
validations:
required: true
- type: textarea
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)
render: shell
validations: validations:
required: false required: false
- type: textarea - type: textarea
@ -106,4 +114,24 @@ body:
description: Provide any relevant specification or other documentation if applicable description: Provide any relevant specification or other documentation if applicable
validations: validations:
required: false required: false
- type: checkboxes
id: checklist
attributes:
label: Pre-Submission Checklist
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
- label: This is a bug report and not a support request
required: true
- label: I have read the security policy and this bug report is not a security issue or security related issue
required: true
- label: I have either included the complete configuration file or I am sure it's unrelated to the configuration
required: true
- label: I have provided all of the required information in full with the only alteration being reasonable sanitization in accordance with the [Troubleshooting Sanitization](https://www.authelia.com/r/sanitize) reference guide
required: true
- label: I have checked for related proxy or application logs and included them if available
required: true
- label: I have checked for related issues and checked the documentation
required: true
... ...

View File

@ -44,4 +44,14 @@ body:
description: Provide any relevant specification or other documentation if applicable description: Provide any relevant specification or other documentation if applicable
validations: validations:
required: false required: false
- type: checkboxes
id: checklist
attributes:
label: Pre-Submission Checklist
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
- label: I have checked for related issues and checked the documentation
required: true
... ...