chore: expand CodeRabbit config with per-package review guidance#75
chore: expand CodeRabbit config with per-package review guidance#75SaharPak wants to merge 2 commits into
Conversation
Add path_instructions for core/cli/web packages and markdown docs, enable ESLint and markdownlint tools, ignore build/dependency output, disable the review poem, and turn on knowledge base learnings.
📝 WalkthroughWalkthroughThe ChangesConfiguration Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.coderabbit.yaml (1)
16-21: 💤 Low valueConsider excluding additional common artifacts.
The current exclusions cover the main build artifacts. You might also consider excluding:
**/.next/**(if using Next.js)**/coverage/**(test coverage reports)**/.cache/**(various tool caches)Only add these if they're relevant to your project structure.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.coderabbit.yaml around lines 16 - 21, Update the path_filters list to add additional common artifact excludes if relevant: add entries like "!**/.next/**", "!**/coverage/**", and "!**/.cache/**" alongside the existing filters (e.g., the current path_filters containing "!**/pnpm-lock.yaml", "!**/dist/**", "!**/.turbo/**", "!**/node_modules/**", "!**/*.snap") so these folders are ignored by the CI/toolchain when applicable to the project.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.coderabbit.yaml:
- Around line 41-45: The repo enables eslint and markdownlint in
.coderabbit.yaml but lacks repository-level configurations; add or confirm
ESLint config (e.g., create an .eslintrc.* or eslint.config.* file or add an
"eslintConfig" section to package.json) and add a markdownlint config (e.g.,
.markdownlintrc, .markdownlint.json or markdownlint settings in package.json) so
the tools referenced under tools: eslint and markdownlint can run; ensure the
config files are committed to the repo root and include any required plugins or
rules referenced by your codebase.
---
Nitpick comments:
In @.coderabbit.yaml:
- Around line 16-21: Update the path_filters list to add additional common
artifact excludes if relevant: add entries like "!**/.next/**",
"!**/coverage/**", and "!**/.cache/**" alongside the existing filters (e.g., the
current path_filters containing "!**/pnpm-lock.yaml", "!**/dist/**",
"!**/.turbo/**", "!**/node_modules/**", "!**/*.snap") so these folders are
ignored by the CI/toolchain when applicable to the project.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 05e584d5-2589-450a-8268-2908e6b1da8e
📒 Files selected for processing (1)
.coderabbit.yaml
| tools: | ||
| eslint: | ||
| enabled: true | ||
| markdownlint: | ||
| enabled: true |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify that ESLint and markdownlint configuration files exist
echo "=== ESLint config ==="
fd -t f -d 2 '\.eslintrc\.(js|cjs|json|yaml|yml)$|eslint\.config\.(js|mjs|cjs)$' . || echo "No .eslintrc.* or eslint.config.* found"
rg -l '"eslintConfig"' package.json || echo "No eslintConfig in package.json"
echo "=== markdownlint config ==="
fd -t f -d 2 '\.markdownlint\.(json|yaml|yml|cjs|mjs)$|\.markdownlintrc$' . || echo "No .markdownlint config found"Repository: TechImmigrants/cv-builder
Length of output: 151
Ensure ESLint/markdownlint configs exist in the repo when enabling them in .coderabbit.yaml.
.coderabbit.yaml enables eslint and markdownlint, but package.json contains no eslintConfig. Add or confirm the repo-level ESLint config (.eslintrc.* or eslint.config.*) and markdownlint config (.markdownlintrc* / markdownlint settings) so CodeRabbit can run both tools correctly.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.coderabbit.yaml around lines 41 - 45, The repo enables eslint and
markdownlint in .coderabbit.yaml but lacks repository-level configurations; add
or confirm ESLint config (e.g., create an .eslintrc.* or eslint.config.* file or
add an "eslintConfig" section to package.json) and add a markdownlint config
(e.g., .markdownlintrc, .markdownlint.json or markdownlint settings in
package.json) so the tools referenced under tools: eslint and markdownlint can
run; ensure the config files are committed to the repo root and include any
required plugins or rules referenced by your codebase.
| stays consistent with the core package's data model. | ||
| - path: "**/*.md" | ||
| instructions: > | ||
| Docs for an open-source project. Check clarity and that setup/commands |
There was a problem hiding this comment.
No a lot of them are the prompts templates not the Docs
| New rules/archetypes/evaluator behavior should have matching vitest tests. | ||
| - path: "packages/cli/**" | ||
| instructions: > | ||
| CLI for the CV builder. Watch for unhandled errors, confusing output, |
There was a problem hiding this comment.
This doesn't match with our cli, because our cli is not traditional cli it's prompt as code, it uses users code agents to do this
| path_instructions: | ||
| - path: "packages/core/**" | ||
| instructions: > | ||
| This is the core CV evaluation/builder logic. Prioritize correctness of |
There was a problem hiding this comment.
Core is orchestrator, the logic is everywhere in intelligence, ingestions, server, frontend, prompts and so on
2 participants
Summary
path_instructionsso CodeRabbit reviewspackages/core,packages/cli, andpackages/web(and markdown docs) with the right context.dist,.turbo,node_modules, snapshots) on top of the existing lockfile filter.This builds on the existing minimal
.coderabbit.yamlonmain.Notes
CodeRabbit reads its config from the PR base branch, so these settings take effect for new PRs once this is merged into
main.Summary by CodeRabbit