Skip to content

Commit

Permalink
Improves issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jqno committed Mar 20, 2024
1 parent 70ef201 commit a6a9390
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 51 deletions.
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/---bug-report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/---feature-request.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: 🐛 Bug report
description: Create a report to help fix a problem in EqualsVerifier
title: '[Bug] '
body:

- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Explain what you did to run into this issue.

- type: textarea
id: error-message
attributes:
label: Error message
description: The error message that EqualsVerifier produces. Include the stack trace if you can.

- type: textarea
id: version
attributes:
label: Version number
description: What version of EqualsVerifier are you using?

- type: textarea
id: code-equalsverifier
attributes:
label: "Code: EqualsVerifier invocation"
description: The code that you used to call EqualsVerifier.

- type: textarea
id: code-class-under-test
attributes:
label: "Code: class under test"
description: The class that you're testing. If you can't share the code due to confidentiality, please anonymize the code.

- type: textarea
id: context
attributes:
label: Additional context
description: Any other information you would like to share.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 📜 Error messages explained
url: https://jqno.nl/equalsverifier/errormessages/
about: You can check here if your problem already has a solution.
- name: 📚 Manual
url: https://jqno.nl/equalsverifier/manual/
about: You can check here how certain features are supposed to work.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 💡 Feature request
description: Suggest an idea to improve EqualsVerifier
title: '[Feature] '
body:

- type: textarea
id: description
attributes:
label: Describe the feature
description: A clear and concise description of what the feature should do.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: Please tell me how you prefer to see this feature implemented.

- type: textarea
id: alternatives
attributes:
label: Describe alternatives
description: Are there alternative solutions you have considered?

- type: textarea
id: context
attributes:
label: Additional context
description: Any other information you would like to share.

0 comments on commit a6a9390

Please sign in to comment.