-
Notifications
You must be signed in to change notification settings - Fork 22
Rewrite templates as yaml forms to improve clarity #262
Conversation
Codecov Report
@@ Coverage Diff @@
## main #262 +/- ##
=======================================
Coverage 83.24% 83.24%
=======================================
Files 36 36
Lines 2949 2949
Branches 274 274
=======================================
Hits 2455 2455
Misses 376 376
Partials 118 118 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
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 idea!
Can you modify https://github.com/canonical/desktop-engineering/blob/main/project-repo/templates/common/.github/ISSUE_TEMPLATE/bug_report.md too (and same for feature requests), and merge any additions that were made there here too? So that we really follow the same template and content?
377f8cf
to
03723d9
Compare
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 think one that one, the throubleshooting guide is fine. We just need to tell to paste the logs.
03723d9
to
3ab861f
Compare
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.
LGTM in general, I've left some comments that apply to both templates, though I've only commented for one template. Feel free to fix both if they make sense to you :). Nice work!
With canonical/desktop-engineering#2, we defined some yaml forms to be used as issue templates for reporting bugs and requesting features on GitHub. This provides a better and more defined way for users to interact with us and provide us with the relevant information we need to solve the problem.
Some users had difficulties when using journalctl to fetch the logs, so this deepens the explanation a little bit in order to help them navigate through journalctl
9a43aea
to
ce7c0c9
Compare
Since this has no impact at all on the tests, I'll merge it without the tests passing while I handle the CI fails. |
With canonical/desktop-engineering#2, we defined some yaml forms to be used as issue templates for reporting bugs and requesting features on GitHub.
This provides a better and more defined way for users to interact with us and provide us with the relevant information we need to solve the problem