Skip to content

Commit

Permalink
Clarify discussion templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ferki committed Feb 10, 2025
1 parent 3ffe8e1 commit 3c85be3
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 53 deletions.
46 changes: 11 additions & 35 deletions .github/DISCUSSION_TEMPLATE/ideas.yml
Original file line number Diff line number Diff line change
@@ -1,47 +1,23 @@
---
labels: 'feature request'
labels: 'triage needed'
body:
- type: markdown
attributes:
value: '## User story'
- type: markdown
attributes:
value: A clear and concise description of _who_ wants to do _what_ and _why_.
- type: input
attributes:
label: As
description: Who?
placeholder: user, contributor, maintainer, engineer, manager, etc.
validations:
required: true
- type: input
attributes:
label: I would like to
description: What?
placeholder: do something new or better with Rex
validations:
required: true
- type: input
- type: textarea
attributes:
label: so I can
description: Why?
placeholder: reach a specific goal
label: User story
description: 'Share the context to start the conversation: [who] wishes to do [what] and [why].'
placeholder: |
As a [user/contributor/maintainer/etc.],
I would like (Rex) to [do something new or better],
so I can [reach a specific goal].
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the feature request here.
- type: markdown
attributes:
value: '---'
- type: textarea
attributes:
label: Describe the solution you would like
description: A clear and concise description of expected behavior, or code examples for expected interfaces.
description: A clear and concise description of the expected behavior, including even code examples.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you have considered
description: A clear and concise description of any alternative solutions or features you have considered, possibly listing pros and cons.
label: Additional context
description: Add any other context about the feature request here, including any alternatives you considered, possibly listing pros and cons.
37 changes: 19 additions & 18 deletions .github/DISCUSSION_TEMPLATE/potential-issues.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,38 @@ labels: 'triage needed'
body:
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
label: Describe your experience
description: A clear and concise description of the observed behavior.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: A clear and concise description of what is expected instead.
description: A clear and concise description of the expected behavior.
validations:
required: true
- type: textarea
attributes:
label: How to reproduce it
description: Steps to reproduce the unexpected behavior.
placeholder: |
1.
2.
3.
1. Do this.
2. Then do that.
3. Observe the issue.
validations:
required: true
- type: textarea
attributes:
label: Code example
description: Shortest code example that demonstrates the bug.
description: Shortest code example that demonstrates the issue, like a Rexfile with a single task.
placeholder: |
```perl
```
- type: textarea
attributes:
label: Additional context
description: For debug logs, run your code with `rex -d`, and [attach the output as a file](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests). If you must copy-paste, make sure to post it as a code block instead of text. Make sure any sensitive information is removed before posting.
description: Share debug logs after running your code with `rex -d`, and [attach the output as a file](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests). Remove any sensitive information before posting. If you choose to copy-paste, make sure to post as a code block instead of text.
- type: markdown
attributes:
value: '## Circumstances'
Expand All @@ -44,6 +44,16 @@ body:
description: Obtain it with `rex -v`.
validations:
required: true
- type: dropdown
attributes:
label: Installation method
options:
- package manager
- cpan client
- dzil install
- other (please describe above)
validations:
required: true
- type: input
attributes:
label: Perl version
Expand All @@ -53,7 +63,7 @@ body:
- type: input
attributes:
label: Operating system running rex
description: Be as specific as possible.
description: As specifically as possible.
validations:
required: true
- type: input
Expand All @@ -63,12 +73,3 @@ body:
placeholder: local
validations:
required: true
- type: dropdown
attributes:
label: How rex was installed?
options:
- package manager
- cpan client
- dzil install
validations:
required: true

0 comments on commit 3c85be3

Please sign in to comment.