|
| 1 | +# PR Artifacts Skill |
| 2 | +You are preparing a pull request for the kore-runtime Kotlin/Spring WebFlux codebase. |
| 3 | +Produce ALL of the following before calling /gsd:ship or opening a PR for review. |
| 4 | + |
| 5 | +## 1. GitHub Issue |
| 6 | +- Verify the PR is linked to a GH issue: `gh issue view <N>` or create one: |
| 7 | + `gh issue create --title "<summary>" --body "..."` |
| 8 | +- Set the issue reference in the PR body: "Closes #N" |
| 9 | + |
| 10 | +## 2. ADR (Architecture Decision Record) |
| 11 | +Required when the PR introduces or changes: |
| 12 | +- A new framework, library, or runtime dependency |
| 13 | +- An infrastructure or deployment topology change |
| 14 | +- A security or authentication pattern |
| 15 | +- A data model or schema decision with long-term impact |
| 16 | +- A cross-module contract (MCP protocol, LLM backend interface, event schema) |
| 17 | + |
| 18 | +Not required for: bug fixes, refactors within existing patterns, test additions. |
| 19 | + |
| 20 | +Use the template at `adr_template.md`. File as `docs/adr/NNNN-short-title.md`. |
| 21 | +NNNN = next sequential number. Commit with message: `docs(adr): NNNN short title` |
| 22 | + |
| 23 | +## 3. Documentation Update |
| 24 | +Update whichever of the following applies: |
| 25 | +- `docs/` — API docs, runbooks, architecture diagrams |
| 26 | +- `README.md` — setup instructions, environment variables |
| 27 | +- KDoc on all public APIs — if public interface changed |
| 28 | +- `CHANGELOG.md` — one-line entry under Unreleased: `- <summary>` |
| 29 | + |
| 30 | +## 4. Tests |
| 31 | +Verify the following before shipping: |
| 32 | +- [ ] Unit tests for every new public function (`*Test.kt` in same package) |
| 33 | +- [ ] Integration test for any new endpoint or MCP handler |
| 34 | +- [ ] Test names follow: `should <expected behaviour> when <condition>` |
| 35 | +- [ ] `./gradlew test` passes silently |
| 36 | +- [ ] `./gradlew jacocoTestCoverageVerification` passes (80% minimum) |
| 37 | + |
| 38 | +## 5. Verification Report |
| 39 | +Produce a brief checklist in the PR description: |
| 40 | +- [ ] All unit tests pass |
| 41 | +- [ ] Coverage >= 80% |
| 42 | +- [ ] ktlint clean (no new violations) |
| 43 | +- [ ] ADR written (or explicitly not required — state why) |
| 44 | +- [ ] Docs updated |
| 45 | +- [ ] GH issue linked |
| 46 | +- [ ] Manual smoke test: describe what you tested and the outcome |
| 47 | + |
| 48 | +## PR Description Template |
| 49 | +``` |
| 50 | +## Summary |
| 51 | +[1-2 sentences: what changed and why] |
| 52 | +
|
| 53 | +## Changes |
| 54 | +- [bullet: concrete change] |
| 55 | +- [bullet: concrete change] |
| 56 | +
|
| 57 | +## Verification |
| 58 | +- [ ] Unit tests pass |
| 59 | +- [ ] Coverage >= 80% |
| 60 | +- [ ] ktlint clean |
| 61 | +- [ ] ADR: docs/adr/NNNN-title.md (or: not required because ...) |
| 62 | +- [ ] Docs updated: [which files] |
| 63 | +- [ ] Issue: Closes #N |
| 64 | +
|
| 65 | +## Manual Testing |
| 66 | +[What you ran and what you observed] |
| 67 | +``` |
0 commit comments