chore: point CodeRabbit at this repository's own conventions - #44
Open
btravers wants to merge 2 commits into
Open
chore: point CodeRabbit at this repository's own conventions#44btravers wants to merge 2 commits into
btravers wants to merge 2 commits into
Conversation
A `.coderabbit.yaml` whose `path_instructions` name the spec file rather than restating it, so there is one copy of the rules and it is the one already under review. The `path_filters` keep generated output and the lockfile out of the diff it reads.
Every `path_filter` except the lockfile named a path git already ignores — `src/generated/**`, `.vitepress/dist/**`, `.vitepress/cache/**` — so none of them could ever appear in a diff for CodeRabbit to filter. Checked with `git ls-files` across all seven repositories: zero tracked files behind any of them. `pnpm-lock.yaml` is the one that is tracked, and the one worth filtering.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds a
.coderabbit.yamlnow that CodeRabbit is installed on the org.It points at this repository's spec rather than restating it. The
conventions are already written down and already reviewed; a second copy in
YAML would be a fifth copy with no gate, which is the drift this org keeps
meeting. So
path_instructionssay read the spec file, hold the diff to it,and spell out only the handful of things a generic reviewer gets actively
wrong — the ones where a suggestion is not debatable but simply not how this
codebase works.
path_filterskeep generated output and the lockfile out of what it reads.Nothing else is configured. Every other key stays at its default, deliberately:
profile: chill, nopoem, norequest_changes_workflow, notoolsblock —the linters CodeRabbit runs are the ones whose config it finds, and this repo's
gate already runs them in CI.
Two knobs worth knowing about rather than setting blind:
reviews.profile: assertiveraises the nitpick volume. Worth trying oncethere is a review or two to judge it against.
reviews.request_changes_workflow: truemakes CodeRabbit block a PR untilits comments are resolved. Off by default, and it should probably stay off
until the instructions have been tuned.
The GitHub App install itself is a click in the CodeRabbit dashboard — this file
does nothing until the app can see the repository.