Skip to content

[Child of #650] Audit: Issue Fields Configuration vs. GitHub API #660

Open

Description

@ashleyshaw

Overview

Validate that issue-fields.yml configuration is complete, correct, and aligns with GitHub's issue fields API.

Scope

  • Review .github/issue-fields.yml configuration
  • Verify custom fields are properly defined
  • Check field mappings to GitHub API
  • Verify field values match what GitHub supports
  • Test field creation/update via automation

Audit Checklist

  • Extract all custom fields from issue-fields.yml
  • Verify field naming conventions
  • Check field types (single_select, date, text, etc.)
  • Verify field values are valid GitHub options
  • Check field descriptions are clear and complete
  • Verify required field configurations
  • Test field creation via API or workflow
  • Identify any deprecated or unsupported fields

Deliverables

  • Issue fields validation report
  • Field configuration checklist
  • Any identified GitHub API misalignments
  • Test results and recommendations
  • Documentation updates (if needed)

Related Files

  • .github/issue-fields.yml
  • docs/ISSUE-FIELDS.md
  • docs/ISSUE_TYPES.md

Related Documentation


Definition of Ready (DoR)

  • Clear problem statement and expected outcome
  • Acceptance criteria defined
  • Related issues/dependencies identified
  • Required resources/approvals listed

Definition of Done (DoD)

  • All acceptance criteria met
  • Changes tested and validated
  • Documentation updated
  • Changes merged and deployed
  • Stakeholders notified

Activity

  1. linear-code commented on May 31, 2026

    @linear-code
  2. added this to the milestone on Jun 1, 2026
  3. ashleyshaw commented on Jun 3, 2026

    @ashleyshaw
    MemberAuthor
  4. ashleyshaw commented on Jun 3, 2026

    @ashleyshaw
    MemberAuthor

    Status update (2026-06-03): Changes affecting this issue are now merged into develop via PR #814 (commit ea285b6). Current issue state remains as-is and reflects the delivered work.

  5. github-actions commented on Jun 19, 2026

    @github-actions
    Contributor

    ⚠️ This issue does not follow a required issue template.

    Missing required section(s): Definition of Ready (DoR), Definition of Done (DoD)

    The issue will remain open and flagged until the body is corrected.
    Please update the issue with one of the official templates:

    If this was opened by automation, update the automation to preserve the template sections before creating the issue.

  6. modified the milestones: , v1.2 on Jul 22, 2026
  7. self-assigned this
    on Sep 8, 2026
  8. github-actions commented on Sep 8, 2026

    @github-actions
    Contributor

    ⚠️ Bare Labels Detected

    This issue has labels that are not in the canonical taxonomy:

    • migrate:priority:normal
    • migrate:type:audit
    • area:labels

    Valid Canonical Labels

    Please use labels with a prefix from the canonical taxonomy:

    • Type: type:bug, type:feature, type:task, type:documentation, etc.
    • Status: status:needs-triage, status:in-progress, status:done, etc.
    • Priority: priority:critical, priority:high, priority:normal, priority:low
    • Area: area:ci, area:docs, area:labels, area:security, etc.
    • Meta: meta:needs-changelog, meta:duplicate, meta:blocked, etc.

    For the complete list, see .github/labels.yml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

Fields

Priority

None yet

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions