Skip to content

Enforce automatic issue template selection and metadata completion on issue creation #1015

@ashleyshaw

Description

@ashleyshaw

Context

Issue creation in this repository must be template-driven, type-aware, and metadata-complete. Markdown issue templates require name and about in front matter, issue forms require name, description, and body, and the repo already documents a canonical workflow for creating issues from templates rather than opening blank issues.

Problem

The current issue creation flow can still produce issues that are missing the template-enforcement structure we require for governance:

  • no explicit Definition of Ready (DoR)
  • no explicit Definition of Done (DoD)
  • incomplete sidebar metadata where fields could be inferred
  • inconsistent issue type template selection
  • risk of ad hoc issue bodies that bypass canonical template routing

Goal

Refine the issue creation automation so that every new issue is routed through the correct numbered issue template, the canonical issue type is applied consistently, and the issue is populated with the maximum safe metadata available at creation time.

Scope

  • Enforce template selection when issues are created, including AI-assisted and workflow-driven creation.
  • Ensure the correct issue type template is applied before the issue is submitted.
  • Maximise issue sidebar metadata completion where the value can be inferred safely.
  • Keep the canonical issue type in sync with the issue template and label set.
  • Update supporting docs/instructions and validation scripts if the workflow contract changes.

Acceptance Criteria

  • A workflow or equivalent automation path exists that creates issues from the canonical numbered template instead of a blank body.
  • The selected issue template matches the canonical issue type for the requested work.
  • New issues include explicit DoR and DoD sections with checkboxes.
  • The automation populates all inferable sidebar metadata fields consistently.
  • The issue body includes the right canonical type references and linked context.
  • Validation covers the workflow contract and fails when DoR/DoD or template selection is missing.
  • Repo guidance documents reflect the required issue creation flow.

Definition of Ready

  • The target issue type is known or can be inferred safely.
  • The correct issue template is mapped for the request.
  • Required metadata fields are known or explicitly marked as unavailable.
  • The workflow path to create the issue is identified.
  • The acceptance criteria for the automation change are agreed.

Definition of Done

  • The issue is created through the canonical template flow.
  • The issue body includes DoR and DoD headings with checkboxes.
  • The correct type:* label is applied and matches the template.
  • Sidebar metadata is populated as fully as automation safely allows.
  • Documentation and validation are updated to reflect the final workflow.
  • The related implementation PR is merged and the issue is closed.

Related

Notes

The intention is not just to validate front matter fields in isolation. The workflow itself should enforce correct issue template selection and issue metadata completeness at the point of creation.

Metadata

Metadata

Assignees

Type

No type

Priority

None yet

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions