Skip to content
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

Convert Github Issue Templates to YAML #21629

Merged
merged 3 commits into from
Jun 10, 2023

Conversation

junwoo091400
Copy link
Contributor

@junwoo091400 junwoo091400 commented May 23, 2023

About

This PR converts existing Markdown based Github Issue templates to YAML.

Changes in visual appearance is shown below.

Benefits

For an intuitive sense of the benefit of having a YAML issue template, visit betaflight's issue page; https://github.com/betaflight/betaflight/issues/new/choose

The YAML provides following benefits:

  1. We can set required fields (e.g. Flight log), and have the user not have to think about editing the raw markdown, as it is rendered like a web UI
  2. We can have each fields having a description only rendered when creating the Issue, so that the final Issue won't have such auxilary comments inside.
  3. We can provide direct links to the resources for support/documentation issue cases. Users don't have to click the button then find the Markdown link for the support link now.

For more information on the YAML templates, read: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

Comparison

Previous markdown based template 👎

image

New YAML based template (example from betaflight) 👍

image

@junwoo091400 junwoo091400 added the Documentation 📑 Anything improving the documentation of the code / ecosystem label May 23, 2023
Copy link
Member

@MaEtUgR MaEtUgR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, why not. Thanks for looking into the workflow 👍

@dagar dagar merged commit 9b95330 into PX4:main Jun 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📑 Anything improving the documentation of the code / ecosystem
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants