Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Rewrite templates as yaml forms to improve clarity #262

Merged
merged 2 commits into from
Jun 29, 2023

Conversation

denisonbarbosa
Copy link
Member

@denisonbarbosa denisonbarbosa commented Jun 19, 2023

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

@denisonbarbosa denisonbarbosa requested a review from a team as a code owner June 19, 2023 11:12
@codecov
Copy link

codecov bot commented Jun 19, 2023

Codecov Report

Merging #262 (9a43aea) into main (57d5e44) will not change coverage.
The diff coverage is n/a.

❗ Current head 9a43aea differs from pull request most recent head ce7c0c9. Consider uploading reports for the commit ce7c0c9 to get more accurate results

@@           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

Copy link
Member

@didrocks didrocks left a 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?

Copy link
Member

@didrocks didrocks left a 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.

.github/ISSUE_TEMPLATE/bug_report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yml Show resolved Hide resolved
Copy link
Contributor

@GabrielNagy GabrielNagy left a 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
@denisonbarbosa denisonbarbosa force-pushed the switch-issue-templates-to-forms branch from 9a43aea to ce7c0c9 Compare June 29, 2023 13:01
@denisonbarbosa
Copy link
Member Author

Since this has no impact at all on the tests, I'll merge it without the tests passing while I handle the CI fails.

@denisonbarbosa denisonbarbosa merged commit faf102b into main Jun 29, 2023
4 of 5 checks passed
@denisonbarbosa denisonbarbosa deleted the switch-issue-templates-to-forms branch June 29, 2023 15:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants