Skip to content

Changing the issue templates from MD files to YAML for better issue creations#22495

Merged
enricobattocchi merged 8 commits intoYoast:trunkfrom
josevarghese:trunk
Jan 8, 2026
Merged

Changing the issue templates from MD files to YAML for better issue creations#22495
enricobattocchi merged 8 commits intoYoast:trunkfrom
josevarghese:trunk

Conversation

@josevarghese
Copy link
Copy Markdown
Member

@josevarghese josevarghese commented Aug 13, 2025

Context

  • YAML format for the issue template to reduce the number of issues created by users without any information on replicating or having any additional information.
  • Right now, we are using the MD template files for issue creation, which is a markdown language, and the issue creators need to know this to fill in the details correctly. However, as GitHub provides YAML support, we can make that into a form for creating issues very easily, with an option to set the required field non-empty.

Summary

This PR can be summarized in the following changelog entry:

  • Changes the issue templates from MD files to YAML for better issues creation.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Ensure that the files in the .github/ISSUE_TEMPLATE are in the branch to see the issue template with the YAML files.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • We can minimize the issues that being created without any details on the repo, as the required fields need to be filled for submission.

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #

@josevarghese josevarghese added the changelog: other Needs to be included in the 'Other' category in the changelog label Aug 13, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Dec 1, 2025

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

@enricobattocchi enricobattocchi added this to the 26.9 milestone Jan 8, 2026
@enricobattocchi enricobattocchi added changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog and removed changelog: other Needs to be included in the 'Other' category in the changelog labels Jan 8, 2026
@enricobattocchi enricobattocchi merged commit 6df3e3a into Yoast:trunk Jan 8, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants