From 6f4e54a11cb41e183e42d89acd002b40aa53d06a Mon Sep 17 00:00:00 2001 From: Nano Taboada Date: Mon, 27 Jul 2026 14:50:48 -0300 Subject: [PATCH] fix(docs): add top-level heading to skill files (MD041) Add "# Create an issue" / "# Key workflows" as the first heading after the YAML front matter in both new skill files, resolving the MD041 (first-line-heading) markdownlint warning CodeRabbit flagged on #355. Co-authored-by: Claude Sonnet 5 --- .claude/skills/create-issue/SKILL.md | 2 ++ .claude/skills/key-workflows/SKILL.md | 2 ++ CHANGELOG.md | 3 +++ 3 files changed, 7 insertions(+) diff --git a/.claude/skills/create-issue/SKILL.md b/.claude/skills/create-issue/SKILL.md index 88a11b0..d6e13fb 100644 --- a/.claude/skills/create-issue/SKILL.md +++ b/.claude/skills/create-issue/SKILL.md @@ -3,6 +3,8 @@ name: create-issue description: Draft a GitHub Issue as the spec artifact for Spec-Driven Development (SDD) before implementing a feature or bug fix in this project. --- +# Create an issue + This project uses Spec-Driven Development (SDD): discuss in Plan mode first, create a GitHub Issue as the spec artifact, then implement. Always offer to draft an issue before writing code. **Feature request** (`enhancement` label): diff --git a/.claude/skills/key-workflows/SKILL.md b/.claude/skills/key-workflows/SKILL.md index 239f952..5b0dc21 100644 --- a/.claude/skills/key-workflows/SKILL.md +++ b/.claude/skills/key-workflows/SKILL.md @@ -3,6 +3,8 @@ name: key-workflows description: Step-by-step guides for adding an endpoint or modifying the schema in this Spring Boot project, plus the branch/commit proposal to make after finishing work. --- +# Key workflows + **Add an endpoint**: Define DTO in `models/` with Bean Validation → add service method in `services/` with `@Transactional` → create controller endpoint with `@Operation` annotation → add tests → run `./mvnw clean test jacoco:report`. **Modify schema**: Create a new Flyway migration `src/main/resources/db/migration/V{N}__description.sql` (production path) → update `@Entity` in `models/Player.java` → update DTOs if API changes → also update `src/test/resources/ddl.sql` and `dml.sql` (tests use Spring SQL init, not Flyway) → update service, repository, and tests → run `./mvnw clean test`. Do not manually edit the SQLite file in `storage/`; Flyway owns it. diff --git a/CHANGELOG.md b/CHANGELOG.md index b5d1841..bda1aef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -74,6 +74,9 @@ Release names follow the **historic football clubs** naming convention (A–Z): ### Fixed +- Add top-level Markdown heading to `create-issue` and `key-workflows` skill + files to resolve MD041 (first-line-heading) — flagged by CodeRabbit on #355 + ### Removed ---