Skip to content

feat: add generic authoring skill#127

Merged
devkade merged 1 commit into
devfrom
feat/issue-126-authoring-skill
May 15, 2026
Merged

feat: add generic authoring skill#127
devkade merged 1 commit into
devfrom
feat/issue-126-authoring-skill

Conversation

@devkade
Copy link
Copy Markdown
Owner

@devkade devkade commented May 15, 2026

Summary

  • Adds a bundled issue-pr-revision-authoring skill with reusable issue, PR body, and revision-comment authoring guidance.
  • Adds concise templates for execution-design issues, current-state tracker issues, evidence-driven investigation issues, engineering-report PR bodies, and current-head revision comments.
  • Adds resource-discovery regression coverage that verifies the bundled skill/template contract and guards against repo-specific policy leakage.

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

  1. Add only templates — small, but misses when/how guidance and genericity boundaries.
  2. Add only SKILL.md — explains the contract, but leaves users without reusable document shapes.
  3. Add SKILL.md plus bundled templates — slightly larger, but gives both selection guidance and copyable structures.

Selected approach: option 3, kept under the review-size target with concise templates.

Changes

Bundled skill — skills/issue-pr-revision-authoring/SKILL.md

  • Defines the execution-design authoring contract.
  • Explains three issue authoring modes: execution-design, current-state tracker, and evidence-driven investigation.
  • Defines PR bodies as engineering reports, not changelogs.
  • Defines revision comments as current-head feedback-response notes.
  • Keeps reviewer bots, merge gates, deployment rules, GitHub App internals, authority semantics, and chat-lane policy out of scope.

Templates — skills/issue-pr-revision-authoring/templates/

  • Adds issue.md with acceptance criteria, verification plan, implementation details, and investigation addendum sections.
  • Adds pr-body.md with linked issue, problem/defect split, changes, design decisions, tests, verification, acceptance criteria, and risks/follow-up.
  • Adds revision-comment.md with current-head SHA, findings addressed, changed files, verification, docs/release notes, remaining items, and ready-for-review statement.

Regression test — test/resource-discovery.test.ts

  • Verifies the new bundled skill and all three templates exist and include the expected authoring sections.
  • Guards against specific repo/policy leakage strings in the generic skill.

Why 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_smells warning 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-failing code_smells warning.
  • git diff --check — pass.
  • Independent reviewer subagent — pass after removing repo-specific author: Ilchul metadata.

Anomalies observed

  • npm test -- test/resource-discovery.test.ts runs the repo's full test/*.test.ts suite because of the package script shape.
  • The test suite emits existing Node [DEP0205] module.register() deprecation warnings.
  • Some npm/test flows temporarily changed src/cli/kapi-review-cli.ts file mode locally; that mode-only churn was reverted before commit and is not included in the PR.

Acceptance criteria

  • Bundled issue-pr-revision-authoring skill added with SKILL.md.
  • templates/issue.md, templates/pr-body.md, and templates/revision-comment.md added.
  • PR template is named pr-body.md.
  • Issue template supports execution-design, current-state tracker, and evidence-driven investigation modes.
  • PR body template includes problem/defect split, changes by surface, design decisions, tests, verification, acceptance criteria, and risks/follow-up.
  • Revision template includes current-head SHA, findings addressed, changed files, verification, docs/release notes, remaining items, and ready-for-review statement.
  • Generic skill excludes repo-specific review/merge/authority policy.

Risks / Follow-up

  • None identified.

@devkade
Copy link
Copy Markdown
Owner Author

devkade commented May 15, 2026

@kapi-agent review

Revision explanation for current head aa4266bcac349890bbed11f5532a4731ea2cb5e3:

What changed:

  • Added the generic issue-pr-revision-authoring bundled skill and three templates for issues, PR bodies, and revision comments.
  • Added regression coverage in test/resource-discovery.test.ts for required sections and genericity boundaries.

Why this closes the prior feedback:

  • Prior blocking issue: no existing Ilchul bundled skill carried this reusable issue/PR/revision authoring contract.
  • Resolution: current head adds the bundled skill/templates while excluding repo-specific reviewer, merge, authority, and chat-lane policy; the repo-specific author: Ilchul metadata was removed after independent review.

Verification:

  • npm ci passed with 0 vulnerabilities.
  • npm run verify passed.
  • npx tsx --test test/resource-discovery.test.ts passed 4/4.
  • npm run check passed.
  • npm run check:unused passed.
  • npm run quality:budgets passed with the existing non-failing code_smells warning.
  • git diff --check passed.
  • Independent reviewer subagent passed after the metadata fix.

@devkade
Copy link
Copy Markdown
Owner Author

devkade commented May 15, 2026

@kapi-agent review

Revision explanation for current head aa4266bcac349890bbed11f5532a4731ea2cb5e3:

What changed:

  • Enabled kapi-agent review processing for devkade/ilchul in the local reviewer bot config after confirming the PR was merge-blocked by missing formal review/check.
  • Current head already contains the generic issue-pr-revision-authoring bundled skill, templates, and regression coverage.

Why this closes the prior feedback:

  • Prior blocking issue: PR feat: add generic authoring skill #127 had no formal current-head kapi-agent review and no kapi-agent/review check because the reviewer bot was configured only for devkade/kapi and devkade/clawhip.
  • Resolution: devkade/ilchul is now included in the reviewer bot enabled repos, and this comment requests review for the unchanged current head.

Verification:

  • curl -fsS http://127.0.0.1:8787/health confirmed enabled_repos includes devkade/ilchul.
  • npm run verify passed for the PR head before opening the PR.
  • npx tsx --test test/resource-discovery.test.ts passed 4/4 after final edits.
  • git diff --check passed.
  • Independent reviewer subagent passed after the metadata fix.

@kapi-agent
Copy link
Copy Markdown

kapi-agent Bot commented May 15, 2026

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.md
  • skills/issue-pr-revision-authoring/templates/issue.md
  • skills/issue-pr-revision-authoring/templates/pr-body.md
  • skills/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 verify exited 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.ts checks 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


kapi-agent request lifecycle:

  • Status: COMPLETED
  • Head: aa4266bcac34
  • Formal review event: APPROVE
  • Review API status: 200
  • Required check API status: 201

Copy link
Copy Markdown

@kapi-agent kapi-agent Bot left a comment

Choose a reason for hiding this comment

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

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.md
  • skills/issue-pr-revision-authoring/templates/issue.md
  • skills/issue-pr-revision-authoring/templates/pr-body.md
  • skills/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 verify exited 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.ts checks 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

@devkade devkade merged commit 87f20d4 into dev May 15, 2026
3 of 4 checks passed
@devkade devkade deleted the feat/issue-126-authoring-skill branch May 15, 2026 09:40
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.

Add generic issue/PR/revision authoring skill

1 participant