-
-
Notifications
You must be signed in to change notification settings - Fork 10
feat: Introduce writing-plans plugin and CodeRabbit CLI for plan quality (#3292) #3293
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
56394ca
docs: Add plan for plan quality improvement (#3292)
KATO-Hiro ac2b817
feat: Introduce writing-plans plugin and CodeRabbit CLI for plan quality
KATO-Hiro 5d9ee57
docs: Clean up plan.md and fix table alignment in coding-style.md
KATO-Hiro 52a6227
docs: Restructure coding-style.md and refine CodeRabbit workflow docs
KATO-Hiro 14e8e9f
docs: Refine CodeRabbit config and directory naming conventions
KATO-Hiro File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "enabledPlugins": { | ||
| "superpowers@superpowers-dev": true | ||
| }, | ||
| "extraKnownMarketplaces": { | ||
| "superpowers-dev": { | ||
| "source": { | ||
| "source": "git", | ||
| "url": "https://github.com/obra/superpowers.git" | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| language: 'ja-JP' | ||
| tone_instructions: '簡潔に。重要度が high 以上のみ詳述し、low/info は箇条書きでまとめる。' | ||
|
|
||
| reviews: | ||
| profile: 'assertive' | ||
| auto_review: | ||
| enabled: true | ||
| drafts: false | ||
| path_filters: | ||
| - '!node_modules/**' | ||
| - '!.pnpm-store/**' | ||
| - '!pnpm-lock.yaml' | ||
| - '!.svelte-kit/**' | ||
| - '!.vercel/**' | ||
| - '!coverage/**' | ||
| path_instructions: | ||
| # --- Data layer --- | ||
| - path: 'prisma/*' | ||
| instructions: | | ||
| - CHECK constraints added manually to migration.sql must be documented in prisma/ERD.md. | ||
| - path: 'prisma/migrations/**' | ||
| instructions: | | ||
| - Auto-generated by Prisma. Only flag security vulnerabilities (e.g. privilege escalation, SQL injection) or bugs that could cause data loss or critical errors. | ||
| - Skip style, naming, SQL formatting, and documentation issues. | ||
| - path: 'src/lib/server/**' | ||
| instructions: | | ||
| - This directory is server-only. Never import from client-side code or Svelte components. | ||
| - DB client must be accessed only via `$lib/server/database`. | ||
| # --- Schema / validation --- | ||
| - path: 'src/**/zod/**' | ||
| instructions: | | ||
| - Use `z.number().int().positive()` for Prisma `Int` fields (not `z.number().positive()`, which passes decimals). | ||
| - When a Zod constraint mirrors a SQL CHECK, add an inline comment noting both layers and the obligation to keep them in sync. | ||
| # --- Domain types --- | ||
| - path: 'src/**/*types/**' | ||
| instructions: | | ||
| - Array types must use a named plural alias: `type Placements = Placement[]`, not `Placement[]` directly in signatures. | ||
| - Add TSDoc to every exported type. | ||
| - Avoid `any`; check if a `@types/*` package exists first. | ||
| # --- Test infrastructure (defined before implementation per TDD) --- | ||
| - path: 'src/**/*fixtures/**' | ||
| instructions: | | ||
| - Use realistic domain values, not abstract placeholders ('t1', 'test1', etc.). | ||
| - Shared fixture data must be extracted to a fixture file; avoid duplicating across test cases. | ||
| # --- Business logic --- | ||
| - path: 'src/**/services/**' | ||
| instructions: | | ||
| - Service functions must return pure values or null; never Response/json(). | ||
| - Prisma calls belong here; do not flag direct database access as a violation. | ||
| - path: 'src/**/*utils/**' | ||
| instructions: | | ||
| - Must be pure functions with no side effects. | ||
| - Each function must have an adjacent unit test. | ||
| # --- State / UI --- | ||
| - path: 'src/**/stores/**' | ||
| instructions: | | ||
| - Stores must use `.svelte.ts` extension, class-based pattern with `$state()`, and export a singleton. | ||
| - Legacy stores using `writable()` must be migrated before adding features or extending them. | ||
| - path: 'src/routes/**' | ||
| instructions: | | ||
| - Page routes (+page.server.ts): use redirect() for navigation. | ||
| - API routes (+server.ts): use error() — redirect() causes fetch to silently receive the HTML page at the redirect target. | ||
| - No direct Prisma calls; delegate to service layer. | ||
| - path: 'src/**/*.svelte' | ||
| instructions: | | ||
| - Use Svelte 5 Runes ($props, $state, $derived, $effect). | ||
| - Business logic belongs in utils/, not inside <script> blocks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.