RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix issue template (#5349) 

Signed-off-by: James Elliott <james-d-elliott@users.noreply.github.com>
pull/5351/head
James Elliott 2023-05-01 14:31:56 +10:00 committed by GitHub
parent 7d6a74ceec
commit 1903979d52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
.github/ISSUE_TEMPLATE/bug-report.yml vendored
View File

@ -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. 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](https://www.authelia.com/r/troubleshooting) reference guide: 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:
- Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section. - Bugs with third-party software.
- 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. - Mistakes in the documentation.
6. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. - 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 - type: dropdown
id: version id: version
attributes: attributes:
@ -106,28 +110,28 @@ body:
id: description id: description
attributes: attributes:
label: Description label: Description
description: Describe the bug description: Describe the bug.
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: reproduction id: reproduction
attributes: attributes:
label: Reproduction label: Reproduction
description: Describe how we can reproduce this issue description: Describe how we can reproduce this issue.
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: expectations id: expectations
attributes: attributes:
label: Expectations label: Expectations
description: Describe the desired or expected results description: Describe the desired or expected results.
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: configuration id: configuration
attributes: attributes:
label: Configuration (Authelia) 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 render: yaml
validations: validations:
required: false required: false
@ -136,9 +140,7 @@ body:
attributes: attributes:
label: Logs (Authelia) label: Logs (Authelia)
description: | description: |
Provide complete logs with the log level set to debug or trace. Complete means from application start until the 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.
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. The template will automatically put this content in a code block so you can just paste it.
render: shell render: shell
@ -148,7 +150,7 @@ body:
id: logs-other id: logs-other
attributes: attributes:
label: Logs (Proxy / Application) 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 render: shell
validations: validations:
required: false required: false
@ -156,14 +158,14 @@ body:
id: documentation id: documentation
attributes: attributes:
label: Documentation label: Documentation
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 - type: checkboxes
id: checklist id: checklist
attributes: attributes:
label: Pre-Submission Checklist 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: options:
- label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) - label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct)
required: true required: true

30
cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl
View File

@ -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. 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](https://www.authelia.com/r/troubleshooting) reference guide: 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:
- Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section. - Bugs with third-party software.
- 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. - Mistakes in the documentation.
6. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. - 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 - type: dropdown
id: version id: version
attributes: attributes:
@ -68,28 +72,28 @@ body:
id: description id: description
attributes: attributes:
label: Description label: Description
description: Describe the bug description: Describe the bug.
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: reproduction id: reproduction
attributes: attributes:
label: Reproduction label: Reproduction
description: Describe how we can reproduce this issue description: Describe how we can reproduce this issue.
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: expectations id: expectations
attributes: attributes:
label: Expectations label: Expectations
description: Describe the desired or expected results description: Describe the desired or expected results.
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: configuration id: configuration
attributes: attributes:
label: Configuration (Authelia) 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 render: yaml
validations: validations:
required: false required: false
@ -98,9 +102,7 @@ body:
attributes: attributes:
label: Logs (Authelia) label: Logs (Authelia)
description: | description: |
Provide complete logs with the log level set to debug or trace. Complete means from application start until the 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.
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. The template will automatically put this content in a code block so you can just paste it.
render: shell render: shell
@ -110,7 +112,7 @@ body:
id: logs-other id: logs-other
attributes: attributes:
label: Logs (Proxy / Application) 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 render: shell
validations: validations:
required: false required: false
@ -118,14 +120,14 @@ body:
id: documentation id: documentation
attributes: attributes:
label: Documentation label: Documentation
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 - type: checkboxes
id: checklist id: checklist
attributes: attributes:
label: Pre-Submission Checklist 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: options:
- label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) - label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct)
required: true required: true