chore: expand CodeRabbit config with per-package review guidance - #75
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 |
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
|
Thanks for expanding the CodeRabbit config! Per-package review guidance is now in the MVP integration branch. This makes automated PR review much more useful going forward. Appreciate the polish! |
* docs: align repository documentation with MVP status Documentation-only audit. No code, evaluator, or rule changes; no new features; no Cloudflare work; no changes to PR #37 or #78. User-facing copy fixed: - README.md: replace misleading ASCII diagram (3 rewrites / Tailored CV) with the actual MVP outputs (Score, Issues, Strengths, ATS verdict, Archetype); clarify that /evaluate-cv ./my-resume.pdf works only because Claude Code reads PDFs natively (the local CLI/web UI parse .md and .txt only). - apps/web-ui layout.tsx: Next.js metadata description replaced with honest CV-evaluator copy (no longer 'Build a tailored resume...'). - apps/web-ui/README.md: list all three routes (/, /results, /feedback), note the static-export + privacy-first posture. - apps/cli/README.md: same PDF-clarification note as the root README. - package.json descriptions (root + core + cli): remove 'tailor / build' wording; describe the deterministic evaluator. - packages/intelligence/README.md: list the eight shipped roles (matches README and the actual implementation) and correct the default archetype (Backend Engineer, not Software Engineer). - packages/eval/README.md: drop the outdated LLM-provider claim; the MVP is fully deterministic. - .claude/skills/cv-evaluation/SKILL.md: 'local MVP', not 'hosted product'; default archetype corrected. - ROADMAP.md: status note added; Phase-1 / #74 / #75 / #76 / #85 / #87 marked as recently shipped; only #37 and #78 remain in progress. Historical docs marked with status notes (not rewritten, just flagged as pre-release context): ARCHITECTURE.md, PROPOSAL.md, PHASE-1.md, V1_SCOPE.md, MVP_DEMO_PLAN.md, PR_CLEANUP_HANDOFF.md, POST_MERGE_VALIDATION.md, REMAINING_PRS_PLAN.md, PR85_ROLLBACK_PLAN.md. Each now points readers to docs/MVP_RELEASE_STATUS.md. New: - docs/REPO_DOCS_AUDIT.md records the audit date, files reviewed, files changed, outdated claims found and fixed, historical docs left intentionally unchanged, remaining risks, and the validation results. Validates: pnpm test (12/12), pnpm lint (0 errors), pnpm build (6/6, fresh --force: emits /, /_not-found, /feedback, /results). * docs: fix remaining Node version reference docs/MVP_DEMO_PLAN.md still said 'Node 22+' in the prereqs section, which conflicts with the actual repo metadata (Node >= 20.0.0 in package.json) and with the authoritative setup guide in docs/LOCAL_DEMO.md. Replace the prereqs with a short pointer to LOCAL_DEMO.md plus a one-line accurate summary, so this historical demo-readiness doc no longer contradicts current setup instructions. docs/REPO_DOCS_AUDIT.md: remove the corresponding entry from the 'remaining documentation risks' list, fix the resulting item numbering, and add a note recording that the Node-version item was resolved before merge. No code, evaluator, or rule changes. No new features. PR #37 and PR #78 untouched. Validates: pnpm test 12/12, pnpm lint 0 errors, pnpm build 6/6 (fresh --force, emits /, /_not-found, /feedback, /results). * docs: address remaining CodeRabbit comments on PR #88 Two unresolved CodeRabbit comments fixed in this commit: 1. README.md — replace hard-coded '5 issues' in the evaluator diagram with the non-fixed wording 'Issues'. evaluate() returns a variable-length issues array; a fixed count would drift as scoring changes. The other diagram labels (Score, Strengths, ATS verdict, Archetype) are kept as-is because they describe deterministic outputs that do not vary in count. 2. packages/intelligence/README.md — the previous audit pass claimed this package ships eight roles and falls back to Backend Engineer. But packages/intelligence/src/archetypes/index.ts registers only three archetypes (Software Engineer, Product Manager, Data & ML Engineer) and DEFAULT_ARCHETYPE is softwareEngineer. Update the README to reflect the actual registry. Add a note clarifying that @cv-builder/core has a separate, broader legacy/runtime registry (7 roles) used by the CLI and Web UI, and that unifying the two registries is a follow-up — see docs/ARCHETYPE_GAP_AUDIT.md. docs/REPO_DOCS_AUDIT.md updated to record that the packages/intelligence/README.md archetype-inventory row was corrected in two steps (the audit pass incorrectly bumped the package claim to 8; this commit brings it back to 3 and adds the @cv-builder/core note). No code changes. No new features. PR #37 and PR #78 untouched. Docs only. Validates: pnpm test 12/12, pnpm lint 0 errors, pnpm build 6/6. --------- Co-authored-by: Cleanup Bot <cleanup-bot@example.com>
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