-
Notifications
You must be signed in to change notification settings - Fork 180
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
DDF-04286 First pass at trying to improve the issue template #4289
Conversation
…ve the issue template
@@ -13,20 +13,25 @@ is the best place for getting support. | |||
|
|||
[Description of the issue] | |||
|
|||
### Steps to Reproduce (if issue is bug) | |||
#### Expected behavior (if applicable): |
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 like this change because it implies that Improvements should have an expected behavior (and they should!)
… not to have multiple Issue templates
I updated the PR to use the newer issue reporting. There are two options which are |
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'd like us to get this merged this morning so we can get the new templates into rotation and see if they start to improve the process.
#### Actual behavior: | ||
<!-- What actually happens --> | ||
|
||
#### Reproduces how often: |
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'm not sure if it needs its own section, but can we add something about potential workarounds?
Maybe that's best suited for the Description block.
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.
Good point 👍 I'm looking at the description within the bug template and it could go there. I don't think we need to have why is this change being proposed
when it's a bug
@@ -0,0 +1,36 @@ | |||
--- | |||
name: Improvement |
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.
❓ Are "New Feature" and "Improvement" the same thing? Should they have different templates?
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'm not sure if the templates would differ aside from auto assigning tags and maybe some of the comments within the description. How do you think the templates would differ?
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'm not sure that they would I was posing it more so as a question. This works for now 👍
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.
They're definitely different but I'm not sure (yet) whether they have different content needs or that we would automate labeling and/or assigning them much differently.
CI skipped for repo metafiles. |
What does this PR do?
Gets the conversation started on fixing the issue template. There are issues that aren't just bugs that also need to be addressed and handled gracefully by the template without making it into a cluttered mess.
I'd love to hear thoughts on the suggestion. This only addresses issues that are categorized into improvements, documentation and bugs.
The hardest issue to handle is documentation since that needs the least information about it, only a description and version, but for improvements and bug issues you can discuss what the expected behavior is
after
the change is implemented, and bugs issues just need the rest of the information.Who is reviewing it?
@coyotesqrl @ricklarsen @rymach @vinamartin
Select relevant component teams:
@codice/website ?
Ask 2 committers to review/merge the PR and tag them here.
How should this be tested?
Consider different issues that may arise and see if they are gracefully handled by the template
Any background context you want to provide?
What are the relevant tickets?
For Jira:
For GH Issues:
Fixes: #4286
Screenshots
Checklist:
Notes on Review Process
Please see Notes on Review Process for further guidance on requirements for merging and abbreviated reviews.
Review Comment Legend: