Skip to content

chore: revise issue templates #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
katie-perry merged 6 commits into from
Jan 2, 2026
Merged

chore: revise issue templates #136

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
504e0f8
chore: revise issue templates
katie-perry Dec 24, 2025
0e07da3
remove expected behavior
katie-perry Dec 24, 2025
4d866b8
adjust wording and combine sections
katie-perry Dec 29, 2025
95a996b
Update .github/ISSUE_TEMPLATE/bug-report.yaml
katie-perry Dec 31, 2025
a346228
be more clear in placeholder for environemnt details
katie-perry Dec 31, 2025
36c21a5
make environment details required
katie-perry Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 24 additions & 60 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,89 +5,53 @@ body:
- type: textarea
attributes:
label: Describe the bug
description: Provide a clear and concise description of what the bug is.
description: Provide a clear and concise description of what the bug is. Include screenshots if applicable.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Provide detailed steps to replicate the bug.
description: |
Provide detailed steps to replicate the bug. Make sure to describe the current behavior.
If applicable, include full errors, stack traces, and/or relevant logs.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true
- type: textarea
attributes:
label: Current behavior
description: |
What actually happened?

Include full errors, stack traces, and/or relevant logs.
validations:
required: true
- type: textarea
attributes:
label: Acceptance Criteria
description: |
Provide the criteria that must be met in order for this issue to be considered fixed.
Be specific, and consider potential edge cases.
validations:
required: true
- type: textarea
attributes:
label: Possible reason(s)
description: Provide any insights into what might be causing the issue.
validations:
required: false
- type: textarea
attributes:
label: Suggested fix
description: Provide any suggestions on how to resolve the bug.
validations:
required: false
- type: textarea
attributes:
label: Branch, commit, and/or version
description: Provide the branch, commit, and/or version you're using.
Be specific, and consider potential edge cases. The criteria should be observable and testable.
placeholder: |
branch: issue-1
commit: abc123d
Given a user or system is in ... (a page, workflow, or state)
And ... (optional other criteria that needs to be met)
When the user ... (action)
Then ... (expected outcome)
And ... (additional observable outcome)
validations:
required: true
- type: textarea
attributes:
label: Screenshots
description: If applicable, add screenshots with descriptions to help explain your problem.
label: Possible reason(s)/Suggested Fix
description: Provide any insights into what might be causing the issue or how to resolve it.
Comment thread
katie-perry marked this conversation as resolved.
Outdated
validations:
required: false
- type: textarea
attributes:
label: Environment details
description: Provide environment details (OS name and version, etc).
validations:
required: true
- type: textarea
attributes:
label: Additional details
description: Provide any other additional details about the problem.
validations:
required: false
- type: dropdown
attributes:
label: Contribution
description: Can you contribute to the development of this feature?
options:
- "Yes, I can create a PR for this fix."
- "Yes, but I can only provide ideas and feedback."
- "No, I cannot contribute."
validations:
required: false
label: Environment & Version
description: |
Provide the branch, commit, and/or version you're using, along with environment details
(e.g., OS name and version, browser, runtime, deployment environment).
placeholder: |
branch:
commit:
Copy link
Copy Markdown

@jennifer-bowser jennifer-bowser Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've ever provided a commit before. I think that usually if we're reporting a bug, it's happening live in one or all of our environments; so the commit hash would just be whatever the most recent commit was? At least, I can't think of a use case where we'd want to provide a different commit then the most recent one.

Of course, there may be some utility for it that I'm not thinking of!

Copy link
Copy Markdown
Member

@korikuzma korikuzma Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For open-source repos, I have used commit before in cases where we haven't made a release yet. While we could just say the most recent commit, I like include the commit for provenance reasons

version:
environment:
Copy link
Copy Markdown
Member

@korikuzma korikuzma Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this

Copy link
Copy Markdown

@jennifer-bowser jennifer-bowser Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth adding more placeholders for the environment part, particularly for our open-source projects where people outside the lab might be reporting bugs? I'm thinking OS and browser could be especially helpful to call out.

Copy link
Copy Markdown
Contributor Author

@katie-perry katie-perry Dec 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is an excellent idea + great feedback - thank you so much! I'll work on updating this

validations:
required: false
Copy link
Copy Markdown
Member

@korikuzma korikuzma Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if we should make this required...


42 changes: 11 additions & 31 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ body:
- type: textarea
attributes:
label: Feature description
description: Provide a clear and concise description of what you want to happen.
description: |
Provide a clear and concise description of what you want to happen.
Include screenshots, wireframes, mockups, diagrams, or other supporting artifacts if available.
validations:
required: true
- type: textarea
Expand All @@ -20,25 +22,19 @@ body:
label: Acceptance Criteria
description: |
Provide the criteria that must be met in order for this issue to be considered complete.
Be specific, and consider potential edge cases.
Be specific, and consider potential edge cases. The criteria should be observable and testable.
placeholder: |
Given a user or system is in ... (a page, workflow, or state)
And ... (optional other criteria that needs to be met)
When the user ... (action)
Then ... (expected outcome)
And ... (additional observable outcome)
validations:
required: true
- type: textarea
attributes:
label: Proposed solution
description: Provide proposed solution.
validations:
required: false
- type: textarea
attributes:
label: Alternatives considered
description: Describe any alternative solutions you've considered.
validations:
required: false
- type: textarea
attributes:
label: Implementation details
description: Provide any technical details on how the feature might be implemented.
description: Describe a possible solution or any technical considerations, if known.
validations:
required: false
- type: textarea
Copy link
Copy Markdown

@jennifer-bowser jennifer-bowser Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't necessarily think we need this section; at least, maybe not as its own standalone thing. I don't find myself using it very much.

I'm down to keep it though if others like having it!

Copy link
Copy Markdown
Member

@korikuzma korikuzma Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like having this because it makes me think of any upstream/downstream changes that may happen.

Expand All @@ -50,19 +46,3 @@ body:
What challenges might arise?
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Provide any other context or screenshots about the feature.
validations:
required: false
- type: dropdown
attributes:
label: Contribution
description: Can you contribute to the development of this feature?
options:
- "Yes, I can create a PR for this feature."
- "Yes, but I can only provide ideas and feedback."
- "No, I cannot contribute."
validations:
required: false
Loading