发布

  • [OPIK-6578] [DOCS] feat: restructure jira-ticket commands to WHY/WHAT body + HOW comment (#6757)

    frostbyte_neo 发布于 2026-05-25 12:13:06 +00:00

    • [OPIK-6578] [INFRA] feat: restructure jira-ticket commands to WHY/WHAT body + HOW comment

    Description template now has only WHY and WHAT sections (with acceptance
    criteria nested under WHAT). Implementation details ("HOW") move out of
    the description into an optional Jira comment posted after creation, with
    a # HOW marker on the first line. The comment is intentionally optional
    so that no HOW is preferred over a filler HOW.

    The work-on-jira-ticket command now scans comments for the HOW marker
    (^#\s*HOW\b, case-insensitive), surfaces it to the model framed as a
    possibly-stale suggestion, and falls back gracefully when none exists.
    Old tickets without a HOW comment continue to work unchanged.

    Re-runs against an existing ticket prefer editing the prior HOW (matched
    by marker AND author email) over piling up new comments, to avoid
    clobbering teammates' suggestions.

    Title and WHAT scope must agree — the title is a one-line version of the
    WHAT.

    Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

    • docs(commands): normalize jira MCP tool names to triple-underscore form

    The file mixed two naming styles for the Jira MCP tools — the older
    mcp_Jira_home_* form in pre-existing sections and the actual current
    mcp__Jira__home___* form in the new HOW-comment sections. The triple-
    underscore form is what the live MCP exposes (verified by every call in
    this PR's history); the single-underscore form was stale documentation.

    Normalize the whole file to the working form.

    Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

    • docs(commands): add optional Functional/Non-Functional Requirements subsections under WHAT

    Restore the FR/NFR distinction that the old template carried, but as
    optional subsections inside the WHAT block — included when the
    distinction is meaningful (multiple behaviors worth enumerating, or
    perf/security/scalability/accessibility constraints that don't fit
    naturally in acceptance criteria), skipped when the WHAT prose and AC
    already say everything.

    Keeps simple tickets terse while making FR/NFR available for tickets
    that genuinely need them.

    Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com


    Co-authored-by: Claude Opus 4.7 (1M context) noreply@anthropic.com

    下载附件