feat: add generic authoring skill#127
Conversation
|
@kapi-agent review Revision explanation for current head What changed:
Why this closes the prior feedback:
Verification:
|
|
@kapi-agent review Revision explanation for current head What changed:
Why this closes the prior feedback:
Verification:
|
kapi-agent reviewVerdict: APPROVE Final approval summaryReview journeyThe original goal was to add a reusable bundled authoring contract for GitHub issues, PR bodies, and revision comments. The semantic scope is limited to generic writing guidance and templates, not repository-specific reviewer, merge, branch, authority, bot, or chat-lane policy. There were no prior kapi-agent blocking findings on this PR head; the author nevertheless provided a current-head revision explanation. What changedThis PR adds:
Why this is correctThe new skill clearly separates reusable authoring standards from repo-specific workflow policy. The templates cover the advertised issue, PR-body, and revision-comment use cases, and the regression test verifies both required sections and absence of known policy-leakage strings. Evidence
Remaining risks and approval rationaleRemaining risks: low. This is documentation/template content plus targeted test coverage. Approval is justified because the PR stays within size policy, verifier passed, the scope is coherent, and no blocking correctness, safety, or workflow-contract issue remains. Blocking issuesNone. Warnings / risks
Suggestions
Looks good
Verification notesVerifier gate status: PASS — Engine: kapi-agent request lifecycle:
|
There was a problem hiding this comment.
kapi-agent review
Verdict: APPROVE
Final approval summary
Review journey
The original goal was to add a reusable bundled authoring contract for GitHub issues, PR bodies, and revision comments. The semantic scope is limited to generic writing guidance and templates, not repository-specific reviewer, merge, branch, authority, bot, or chat-lane policy. There were no prior kapi-agent blocking findings on this PR head; the author nevertheless provided a current-head revision explanation.
What changed
This PR adds:
skills/issue-pr-revision-authoring/SKILL.mdskills/issue-pr-revision-authoring/templates/issue.mdskills/issue-pr-revision-authoring/templates/pr-body.mdskills/issue-pr-revision-authoring/templates/revision-comment.md- Regression coverage in
test/resource-discovery.test.ts
Why this is correct
The new skill clearly separates reusable authoring standards from repo-specific workflow policy. The templates cover the advertised issue, PR-body, and revision-comment use cases, and the regression test verifies both required sections and absence of known policy-leakage strings.
Evidence
- Verifier gate: PASS —
npm ci && npm run verifyexited 0. - Size gate: PASS — 191 changed lines, under the 200-line limit.
- Revision-explanation status: not required, found.
- Inspected local files and diff stat for the new skill, templates, and resource-discovery regression test.
Remaining risks and approval rationale
Remaining risks: low. This is documentation/template content plus targeted test coverage. Approval is justified because the PR stays within size policy, verifier passed, the scope is coherent, and no blocking correctness, safety, or workflow-contract issue remains.
Blocking issues
None.
Warnings / risks
test/resource-discovery.test.tschecks representative required text and leakage strings, but it does not validate every possible future repo-specific phrase. This is acceptable for this scope.
Suggestions
- Consider adding a short usage example in a future PR if users need help choosing between the three issue modes.
Looks good
- The skill explicitly excludes reviewer bots, merge gates, deployment policy, webhook behavior, and authority semantics.
- The PR-body template correctly frames PRs as engineering reports rather than changelogs.
- The revision-comment template requires current-head SHA, addressed findings, verification, and readiness evidence.
- Regression coverage protects the core contract and genericity boundary.
Verification notes
Verifier gate status: PASS — npm ci && npm run verify exited 0.
Size gate status: PASS — 191 changed lines < 200.
Revision-explanation status: not required, found.
Local inspection covered the changed skill, templates, diff stat, and test additions.
Engine: pi
Summary
issue-pr-revision-authoringskill with reusable issue, PR body, and revision-comment authoring guidance.Linked issue
Closes #126
Problem
Ilchul did not yet carry a generic authoring contract for GitHub issues, PR bodies, and review revision comments. Existing guidance could be scattered across workflow-specific surfaces, which makes it easy to mix reusable writing standards with repo-specific reviewer, branch, merge, authority, or chat-lane policy.
Options considered
Selected approach: option 3, kept under the review-size target with concise templates.
Changes
Bundled skill —
skills/issue-pr-revision-authoring/SKILL.mdTemplates —
skills/issue-pr-revision-authoring/templates/issue.mdwith acceptance criteria, verification plan, implementation details, and investigation addendum sections.pr-body.mdwith linked issue, problem/defect split, changes, design decisions, tests, verification, acceptance criteria, and risks/follow-up.revision-comment.mdwith current-head SHA, findings addressed, changed files, verification, docs/release notes, remaining items, and ready-for-review statement.Regression test —
test/resource-discovery.test.tsWhy this fixes it
The new bundled skill provides one portable authoring contract while preserving separation between generic writing standards and repository-specific workflow policy.
QA / Verification
npm ci— pass, installed dependencies; 0 vulnerabilities.npm run verify— pass; 396 tests, 385 pass, 11 skipped;tsc,tsc --noUnusedLocals --noUnusedParameters, and quality budgets exited 0. Existing quality budget result:code_smellswarning remains non-failing.npx tsx --test test/resource-discovery.test.ts— pass, 4/4.npm run check— pass.npm run check:unused— pass.npm run quality:budgets— pass with existing non-failingcode_smellswarning.git diff --check— pass.author: Ilchulmetadata.Anomalies observed
npm test -- test/resource-discovery.test.tsruns the repo's fulltest/*.test.tssuite because of the package script shape.[DEP0205] module.register()deprecation warnings.src/cli/kapi-review-cli.tsfile mode locally; that mode-only churn was reverted before commit and is not included in the PR.Acceptance criteria
issue-pr-revision-authoringskill added withSKILL.md.templates/issue.md,templates/pr-body.md, andtemplates/revision-comment.mdadded.pr-body.md.Risks / Follow-up