Skip to content

[Feature]: Clarify issue readiness check comment and reference templates #4626

Description

@jpshackelford

Problem Statement

The automated issue readiness check (issue-readiness-check.yml via post-readiness-comment.mjs) currently posts a verbose comment when an issue fails the readiness gate. It does not explicitly link to the repository issue template definitions (.github/ISSUE_TEMPLATE/*.yml), and does not explain why type labels (enhancement or bug) are missing when issues are filed outside the Web UI (e.g. via CLI or API by contributors without triage/label permissions).

Desired Behavior

Update .github/scripts/post-readiness-comment.mjs to:

  1. Make the ready-for-dev failure comment concise and scannable.
  2. Link directly to .github/ISSUE_TEMPLATE/feature_request.yml and .github/ISSUE_TEMPLATE/bug_template.yml for full schema reference.
  3. Clarify that labels are applied automatically when using the Web UI template, and that maintainers will add missing labels during triage for CLI/API submissions.

Acceptance Criteria

  • The not ready-for-dev comment is concise and links to the template files.
  • The comment clarifies label triage for CLI/API submitters.
  • Syntax and cross tests pass without regressions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestready-for-devIssue meets development readiness criteria

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions