Skip to content

Commit

Permalink
maint: start using issue forms
Browse files Browse the repository at this point in the history
New issue reports are expected to improve.

Close #399

Signed-off-by: Claudio André <dev@claudioandre.slmail.me>
  • Loading branch information
claudioandre-br committed May 24, 2024
1 parent 04f3687 commit 27a2a54
Show file tree
Hide file tree
Showing 6 changed files with 111 additions and 79 deletions.
55 changes: 0 additions & 55 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Bug Report
description: Create a report to help us improve.
title: "[BUG]: "
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
We expect reports of issues from the latest revision found in GitHub repository. We do not expect in here, and
have little use for, reports of issues only seen in an ancient release or in a distro package.
- type: dropdown
attributes:
label: Which version of the application are you using?
description: Select the appropriate versions.
multiple: true
options:
- 1.9J1+2404
- latest bleeding
validations:
required: true

- type: textarea
id: bug-description
attributes:
label: Description of the bug
description: Tell us what bug you encountered and what should have happened.
placeholder: |
The more information you can provide, the easier it will be to reproduce the issue and find a fix.
validations:
required: true

- type: textarea
attributes:
label: Steps To Reproduce
description: |
The command-line you executed and the output you got.
placeholder: Please write the steps in a list form
validations:
required: false

- type: textarea
attributes:
label: Your execution environment
placeholder: |
The output of './john --list=build-info'
The output of './john --list=opencl-devices' (if applicable)
validations:
required: false
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Feature Request
description: Request a new feature.
title: "[FEAT]: "
labels: "Type: Feature Request"

body:
- type: markdown
id: header
attributes:
value: |
Thanks for filling out this feature request.
- type: textarea
id: description
attributes:
label: Description
description: A brief description of the feature request.
placeholder: |
Provide a clear and concise description of the new feature you'd like to see.
For example: I'm always frustrated when [...]
validations:
required: true

- type: textarea
attributes:
label: Alternatives Considered
description: Alternatives to this feature request.
placeholder: Provide details around any alternative solutions or features you've considered.
validations:
required: false

- type: textarea
attributes:
label: Additional Context
description: Other relevant context.
placeholder: |
Add any other context about your feature request here. E.g. paste a screenshot, or provide a link.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Question
description: Ask us a question.
labels: ["question"]

body:
- type: markdown
attributes:
value: |
Thank you for asking a question!
- Remember to include sufficient details and context.
- If you have multiple questions please submit them separately so we can track resolution.
- If you're trying to start a conversation on a topic, consider using [Discussions](https://github.com/openwall/john-packages/discussions).
We want to close every issue as quickly as possible, but discussions are intended for longer conversations.
- type: textarea
id: question
attributes:
label: Question
description: What would you like to know?
placeholder: The more details, the better
validations:
required: true
1 change: 0 additions & 1 deletion .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,6 @@ tcp
templatefile
terraform
tfstate
thumbsup
tld
tls
tmp
Expand Down

0 comments on commit 27a2a54

Please sign in to comment.