chore: revise issue templates #136
Conversation
katie-perry
added
chore
| - type: textarea | ||
| attributes: | ||
| label: Branch, commit, and/or version | ||
| description: Provide the branch, commit, and/or version you're using. | ||
| placeholder: | | ||
| branch: issue-1 | ||
| commit: abc123d |
There was a problem hiding this comment.
Should this section and the environment details be merged in the steps to reproduce section?
There was a problem hiding this comment.
love this idea!
There was a problem hiding this comment.
I ended up combining the branch/commit/version and environment details sections in the most recent commit. I was considering putting it in the steps to reproduce section but I was worried about it being too wordy or overloaded and making it not easy to scan through bug tickets and find out where they may apply... I'm sorta still going back and forth on if that's necessary though. I feel like 99% of the time, we end up putting "all" for the affected environments because we don't often create sub-issues or create issues for bugs that arise from other in-progress or not-released-yet features...
| - type: textarea | ||
| attributes: | ||
| label: Describe the bug | ||
| description: Provide a clear and concise description of what the bug is. |
There was a problem hiding this comment.
Consider adding screenshots to the description?
There was a problem hiding this comment.
Added a note about that + added a sort of corresponding note in the feature issue template to add screenshots/wireframes/mockups (for UI issues) or diagrams/other supporting artifacts (for API issues)!
| placeholder: | | ||
| branch: | ||
| commit: | ||
| version: | ||
| environment: |
| version: | ||
| environment: | ||
| validations: | ||
| required: false |
There was a problem hiding this comment.
I'm wondering if we should make this required...
jennifer-bowser
left a comment
jennifer-bowser
left a comment
There was a problem hiding this comment.
I have just a couple minor suggestions. This looks great, I'm excited to use the new streamlined templates! 😄
| (e.g., OS name and version, browser, runtime, deployment environment). | ||
| placeholder: | | ||
| branch: | ||
| commit: |
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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
| branch: | ||
| commit: | ||
| version: | ||
| environment: |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
this is an excellent idea + great feedback - thank you so much! I'll work on updating this
| description: Describe a possible solution or any technical considerations, if known. | ||
| validations: | ||
| required: false | ||
| - type: textarea |
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
I like having this because it makes me think of any upstream/downstream changes that may happen.
Co-authored-by: Kori Kuzma <korikuzma@gmail.com>
close #135