|
| 1 | +# PR Artifacts Skill — TypeScript + Kotlin Hybrid |
| 2 | + |
| 3 | +Produce ALL of the following before opening a PR for review. |
| 4 | + |
| 5 | +## 1. GitHub Issue |
| 6 | +- Verify the PR is linked to a GH issue |
| 7 | +- Set the issue reference in the PR body: "Closes #N" |
| 8 | + |
| 9 | +## 2. ADR (Architecture Decision Record) |
| 10 | +Required when the PR introduces or changes: |
| 11 | +- GitHub Action inputs/outputs contract |
| 12 | +- Gradle plugin DSL or task configuration |
| 13 | +- Integration approach with spec-linter/injection-scanner/ai-changelog |
| 14 | +- PR comment format or template |
| 15 | + |
| 16 | +Not required for: bug fixes, test additions, documentation. |
| 17 | + |
| 18 | +File as `docs/adr/NNNN-short-title.md`. |
| 19 | + |
| 20 | +## 3. Documentation Update |
| 21 | +- `README.md` — if new inputs, outputs, or behavior |
| 22 | +- `action.yml` — keep inputs documented |
| 23 | +- Inline JSDoc (TypeScript) or KDoc (Kotlin) on public APIs |
| 24 | + |
| 25 | +## 4. Tests |
| 26 | +TypeScript (GitHub Action): |
| 27 | +- [ ] `npm test` passes |
| 28 | +- [ ] `npm run lint` passes (tsc --noEmit) |
| 29 | +- [ ] `npm run format` passes (prettier) |
| 30 | + |
| 31 | +Kotlin (Gradle Plugin): |
| 32 | +- [ ] `./gradlew test` passes |
| 33 | +- [ ] `./gradlew ktlintCheck` passes |
| 34 | + |
| 35 | +## 5. Verification Report |
| 36 | +- [ ] No `any` types (TypeScript), no `!!` (Kotlin) |
| 37 | +- [ ] No secrets or tokens in code |
| 38 | +- [ ] ADR written (or: not required because ...) |
| 39 | +- [ ] Issue: Closes #N |
| 40 | +- [ ] Smoke test described |
0 commit comments