-
Notifications
You must be signed in to change notification settings - Fork 606
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
add github issue templates for bug report and feature request, to facilitate project management #1348
Conversation
btw, you can try and see it yourself here |
Codecov Report
@@ Coverage Diff @@
## main #1348 +/- ##
==========================================
- Coverage 19.82% 19.79% -0.03%
==========================================
Files 202 202
Lines 27685 27725 +40
==========================================
Hits 5489 5489
- Misses 21175 21215 +40
Partials 1021 1021
Continue to review full report at Codecov.
|
Hi @jlbit ! Thanks for this template. Everything looks great. I would only like to suggest having another type of issue. I think it would be useful to have a story/task type of issue to be mainly used by the core team. Feature requests and the suggested template seem to be useful for external contributors. On the other hand, when our team members write up the issues, they are, oftentimes, not requests but well-defined stories or tasks. In addition, I find having "Acceptance Criteria" extremely useful. These short descriptions help with defining what exactly needs to be fulfilled for a solution to the issue to be accepted. It helps the author of the issue to plan the scope in advance. Moreover, it eases the reviewer's job by letting them go through the checklist and make sure that all "Acceptance Criteria" have been met. I've brought this up with the team, and folks seemed to be happy to try it. Please take a look at the following example of its use: #1332 Let me know what you think |
@p0mvn right, the feature requests are from external users, and @daniel-farina pointed out that such requests should be in https://github.com/osmosis-labs/feature-requests/issues rather than the main repo to avoid distraction. I've updated the PR to have feature_request.md redirecting to https://github.com/osmosis-labs/feature-requests/issues, and greatly simplified bug_reports.md |
Thanks for the update @jlbit My earlier comment about needing a type for a story/task issue still seems to apply. Our team doesn't only create issues for bugs. Most of the time, we create an issue to do a simple task that may or may not require a code change or investigate a problem. The current bug report template wouldn't apply to a large proportion of the issues that our team creates since most of them are not bugs. Having a story/task type of issue with sections like:
I understand that this issue type would primarily be meant to be used by the team. We could add a note in the description about the purpose of this template. |
@@ -0,0 +1,10 @@ | |||
--- |
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.
We have a separate repo for feature requests? Can I ask why?
|
||
**Describe the bug** | ||
|
||
*E.g. when doing ..., ... unexpectedly happened* |
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.
This is what I'm not a fan of in the PR template. This adds noise to the template and the author. Instead, can we put all the examples and helpful test in markdown comments, so the author doesn't have to always delete things?
I'm going to close this for now since there is a more up to date PR with this: #1399 Please let me know if any concerns |
Closes: #1339
What is the purpose of the change
This PR adds github issue templates for bug report and feature request, to facilitate project management and prioritization
Brief change log
Testing and Verifying
Tested in my local repo. Here's the workflow and screenshots
Documentation and Release Note
Unreleased
section inCHANGELOG.md
? (no)