Skip to content

Standardise front matter field usage across templates, prompts, and validation #1012

@ashleyshaw

Description

@ashleyshaw

Context

GitHub issue template Markdown files require name and about in front matter, while issue form YAML uses name and description. In this repository, several issue and PR templates now expose both about and description, which suggests the current migration duplicated metadata instead of establishing a canonical field strategy.

Problem

We do not currently have a single, documented rule for when front matter should use about versus description across:

  • .github/ISSUE_TEMPLATE/*.md
  • .github/PULL_REQUEST_TEMPLATE/*.md and .github/pull_request_template.md
  • prompts/*.prompt
  • instructions/*.instructions.md
  • validation schema and scripts
  • related docs/config that describe or generate front matter

Goal

Decide and document the canonical front matter field mapping, then update the repository so the chosen convention is enforced everywhere without duplicated metadata.

Scope to confirm before implementation

  • Whether about should be the canonical field for GitHub template metadata only, or whether it should replace description more broadly.
  • Whether PR templates should keep repo-local front matter metadata, and if so which field is canonical there.
  • Whether a migration prompt should be added under prompts/ to automate future bulk alignment.

Acceptance criteria

  • A documented, repo-wide front matter standard exists for GitHub templates, prompts, instructions, and docs.
  • The front matter schema and validation scripts reflect the approved standard.
  • Tests cover the approved field behaviour and fail on the wrong field usage.
  • Relevant instruction files and config/docs are updated to match the approved standard.
  • A migration prompt is added if needed to support future bulk updates.

Notes

This work should be done as a focused migration after approval, with validation evidence captured in the PR.

Metadata

Metadata

Assignees

Type

No type

Priority

None yet

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions