Skip to content

✨ Review/update PR description on develop and fix-ci runs#94

Merged
monkut merged 2 commits into
mainfrom
feature/develop-fixci-pr-description-update
Apr 28, 2026
Merged

✨ Review/update PR description on develop and fix-ci runs#94
monkut merged 2 commits into
mainfrom
feature/develop-fixci-pr-description-update

Conversation

@monkut

@monkut monkut commented Apr 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • develop and fix-ci action prompts now review and refresh the existing PR description whenever changes are pushed to a branch with an open PR.
  • develop requires a GitHub auto-close keyword (Closes #<n> / Fixes #<n>) in the PR body so the originating issue links to the PR and closes on merge.
  • Concision pass across all action prompts (PREPARE, PLAN, DEVELOP, REVIEW, EXPLORE, DIAGNOSE, REVIEWPR, FIX-CI) per review feedback — removes filler articles and verbose phrasing while preserving meaning.

Additions

  • Shared helper — new PR_DESCRIPTION_UPDATE_BODY constant in askcc/definitions.py, wrapped as DEVELOP_PR_DESCRIPTION_UPDATE (top-level section) and FIXCI_PR_DESCRIPTION_UPDATE (4-space-indented sub-step under fix-ci's numbered list). Keeps wording in sync between the two prompts.
  • develop promptOn completion distinguishes the new-PR vs existing-PR cases and points at the new PR description update section. The PR description section gains a bullet requiring Closes #<issue-number> / Fixes #<issue-number> in the PR body.
  • fix-ci prompt — new step 14 reviews and updates the PR description (refresh ## Verification, ## Summary, ## Key Flows, ## Test plan) before posting the summary comment (now step 15).
  • Concision pass — tightens language across all 8 agent prompts and their user templates. Removes "operating inside Claude Code", "the given", "you must perform two actions", redundant articles, etc. Net −29 lines across definitions.py + tests.
  • Tests — three new test classes in tests/test_askcc.py (TestDevelopPromptPrDescriptionUpdate, TestDevelopPromptIssueReference, TestFixciPromptPrDescriptionUpdate) — 13 new substring/ordering assertions. Existing TestDevelopPromptTestPlanUpdate and the new tests updated for the concise wording.

Key Flows

flowchart TD
    A[develop/fix-ci finishes change] --> B{open PR exists for branch?}
    B -- no, develop --> C[open new PR with Closes #N in body]
    B -- yes --> D[read existing PR body]
    D --> E[refresh Verification, Summary, Key Flows, Test plan]
    E --> F[gh pr edit --body]
    C --> G[post issue/PR comment]
    F --> G
Loading

Verification

  • uv run pytest — passed (214 tests)
  • uv run ruff check . — passed (no issues)
  • uv run ruff format --check askcc/definitions.py tests/test_askcc.py — passed
  • uv run pyright askcc/definitions.py — passed (0 errors)

Test plan

  • Verify DEVELOP_AGENT_PROMPT includes the new PR description update heading
  • Verify DEVELOP_AGENT_PROMPT includes Closes #<issue-number> / Fixes #<issue-number> in the PR description section
  • Verify FIXCI_AGENT_PROMPT includes the new "Review and update the PR description" step
  • Verify the fix-ci PR-description-update step is ordered before the summary-comment step
  • Verify both prompts share the same read/edit gh pr commands for the body
  • Verify concision pass leaves all existing test substrings intact (or updates the tests to match)
  • Manual: run askcc develop against an issue with an existing PR and confirm the description is refreshed
  • Manual: run askcc fix-ci and confirm the PR description's ## Verification section is updated post-fix

Develop and fix-ci now review and refresh the existing PR description
when pushing changes to a branch with an open PR. Develop also requires
a GitHub auto-close keyword (Closes/Fixes #N) in the PR body so the
target issue is linked and closes on merge.

@monkut monkut left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good, but simplify language, maintaining the full meaning but keeping it consise.

Ex)

Read the current PR body -> Read current PR body

Concision pass per PR #94 review feedback. Removes filler articles, redundant
phrases, and verbose constructs across PREPARE, PLAN, DEVELOP, REVIEW, EXPLORE,
DIAGNOSE, REVIEWPR, and FIX-CI prompts (and their user-prompt templates) while
preserving meaning. Updates the new PR-description-update tests to match the
shortened substrings.
@monkut

monkut commented Apr 28, 2026

Copy link
Copy Markdown
Owner Author

Addressed in 9207382: applied a concision pass to all action prompts (PREPARE, PLAN, DEVELOP, REVIEW, EXPLORE, DIAGNOSE, REVIEWPR, FIX-CI) and their user-prompt templates.

  • The reviewer's example (Read the current PR bodyRead current PR body) is applied to the new PR_DESCRIPTION_UPDATE_BODY and propagated through both DEVELOP and FIX-CI.
  • Filler articles, redundant phrases, and verbose constructs trimmed throughout while preserving meaning.
  • Net diff: +256 / −285 lines (29 lines net reduction across the two files).
  • Affected tests in TestDevelopPromptPrDescriptionUpdate, TestDevelopPromptTestPlanUpdate, and TestFixciPromptPrDescriptionUpdate were updated to match the new substrings; full suite of 214 tests passes.

@monkut monkut merged commit b9c2a32 into main Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant