Skip to content

feat(build-pr-description): port generic writing rules from build-readme - #19

Merged
gitt510 merged 1 commit into
mainfrom
refine-build-pr-description
Aug 28, 2026
Merged

feat(build-pr-description): port generic writing rules from build-readme#19
gitt510 merged 1 commit into
mainfrom
refine-build-pr-description

Conversation

@gitt510

@gitt510 gitt510 commented Aug 28, 2026

Copy link
Copy Markdown
Owner

Why

  • build-pr-description lacks the generic writing rules that build-readme already enforces, so the same prose smells (meta-bullets, rationale in What, vague verbs) slip into PR bodies
    • build-readme's 形式 section defines the three allowed forms and bans 「以下は〜」 meta-bullets; build-pr-description referenced it by name only
    • build-readme carries a 書き換え技法 section; build-pr-description had no equivalent for What

What

skills/build-pr-description/SKILL.md

  • 形式 section spells out the three allowed forms (bullet list / table / code block) instead of referring to build-readme
  • New 書き換え技法 section: rationale → observable guarantee, operation → invariant, explicit object for vague verbs
  • 完了チェック gains a meta-bullet (「以下は〜」) check

Test

  • Rebased onto main (one conflict in SKILL.md resolved by keeping the 主張→根拠 Why rules and adding the ported sections)

- add 書き換え技法 section (rationale→guarantee, operation→invariant, vague-verb targets) adapted to What
- ban meta-bullets (「以下は〜」) in format rules and completion checklist
- state no-period rule for bullets explicitly
- align table criterion with build-readme (rows are facts, columns compared)
- inline the 3-format rules instead of referencing build-readme

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@gitt510
gitt510 merged commit adaf5fb into main Aug 28, 2026
1 check passed
@gitt510
gitt510 deleted the refine-build-pr-description branch August 28, 2026 14:56
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