-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Changes from all commits
504e0f8
0e07da3
4d866b8
95a996b
a346228
36c21a5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
|
@@ -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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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!
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||
|
|
@@ -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 | ||
There was a problem hiding this comment.
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
commitbefore. 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!
There was a problem hiding this comment.
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