Skip to content

chore: add advisory CodeRabbit contribution reviews - #348

Merged
tt-a1i merged 1 commit into
mainfrom
codex/coderabbit-review
Sep 8, 2026
Merged

chore: add advisory CodeRabbit contribution reviews#348
tt-a1i merged 1 commit into
mainfrom
codex/coderabbit-review

Conversation

@tt-a1i

@tt-a1i tt-a1i commented Sep 8, 2026

Copy link
Copy Markdown
Owner

Problem and value

Maintainers repeatedly reconstruct each PR's scope and ask for missing validation evidence. Configure a bounded CodeRabbit pilot to apply the existing contribution guide and PR template automatically, while keeping human compatibility decisions and existing CI gates. Refs #344.

Scope

  • Add root .coderabbit.yaml: automatic non-draft and incremental review, two advisory checks for contribution scope and validation evidence, and focused instructions for shared diagram code and packages.
  • Load canonical contribution, PR-template, and delivery-contract documents. Distinguish observed results from author claims, missing evidence from defects, and browser evidence from perceptual review.
  • Keep feedback concise; disable poems, generated sequence diagrams, slop labeling, and code-generation finishing touches. Keep review knowledge scoped to this repository.
  • Add a short contributor note covering the pilot, manual review command, evaluation, and pause switch.
  • No runtime, renderer, schema, release, or branch-protection changes.

Stability impact

Configuration and contributor documentation only. All custom checks are warnings and request-changes/automatic approval is disabled. The GitHub App has now been enabled for Archify, and its first review explicitly loaded this configuration at 6f6d77fea6fa4e10a5239d67ea17a72d2345cb2b. Existing CI and maintainer approval remain authoritative. Pause via reviews.auto_review.enabled: false or revert this configuration.

Tests run

At head 6f6d77fea6fa4e10a5239d67ea17a72d2345cb2b, Python 3.14.6, PyYAML 6.0.3, jsonschema 4.26.0. The following commands were run from the repository root, using an isolated temporary virtualenv:

python3 -m venv /tmp/archify-coderabbit-check
/tmp/archify-coderabbit-check/bin/pip -q install pyyaml jsonschema
curl -fLsS https://coderabbit.ai/integrations/schema.v2.json -o /tmp/archify-coderabbit-schema.json
/tmp/archify-coderabbit-check/bin/python - <<'PY'
import sys, json, pathlib, yaml, jsonschema, importlib.metadata, hashlib
root = pathlib.Path('.')
raw = pathlib.Path('/tmp/archify-coderabbit-schema.json').read_bytes()
schema = json.loads(raw)
config = yaml.safe_load((root / '.coderabbit.yaml').read_text())
errors = list(jsonschema.Draft202012Validator(schema).iter_errors(config))
assert not errors, errors
keys = []
def check_keys(value, shape, prefix=''):
    if isinstance(value, dict) and 'properties' in shape:
        for key, item in value.items():
            assert key in shape['properties'], f'Unknown key: {prefix}{key}'
            keys.append(prefix+key)
            check_keys(item, shape['properties'][key], prefix+key+'.')
    elif isinstance(value, list) and 'items' in shape:
        for item in value: check_keys(item, shape['items'], prefix+'[].')
check_keys(config, schema)
paths = config['knowledge_base']['code_guidelines']['filePatterns']
assert all((root / file).is_file() for file in paths)
checks = config['reviews']['pre_merge_checks']['custom_checks']
assert config['reviews']['request_changes_workflow'] is False
assert all(c['mode'] == 'warning' for c in checks)
print(json.dumps({'python':sys.version.split()[0], 'PyYAML':yaml.__version__, 'jsonschema':importlib.metadata.version('jsonschema'), 'schema_sha256':hashlib.sha256(raw).hexdigest(), 'schema_errors':len(errors), 'known_properties':len(keys), 'guideline_paths':len(paths), 'warning_checks':len(checks)},indent=2))
PY
git diff --check

Results: exit 0; 0 schema errors, 59 known property occurrences, 3 existing guideline paths, 2 warning-mode custom checks, automatic approval disabled. Schema SHA-256: 8c34e033182463bd4f2a823b144077cb21cc327927fb82ce49791bdae2b9da13. git diff --check exited 0 with no findings.

  • Final-head CI: all 10 applicable jobs passed, including Node 18/20/22/24 tests, three-platform package smoke, ZIP freshness, published manifest, and browser artifact checks; PR Pages deployment skipped as designed.
  • Runtime and visual tests were not rerun locally because no runtime or artifact inputs changed. Remote CI is separate observed evidence and does not establish a new perceptual review.
  • CodeRabbit review and evidence recheck: no actionable code comments. Both custom checks, Contribution Scope and Validation Evidence, passed after the exact commands above were added. The two built-in linked-issue checks were explicitly skipped because GitHub has no linked closing issue; they are not claimed as executed acceptance. This verifies a real warning, correction, and recheck without changing the code head.

Visual evidence

Not applicable: no delivered diagram, Viewer, or public-page changes.

Generated artifacts

None. Configuration and CONTRIBUTING.md are not Skill/ZIP or Gallery build inputs.

Pilot acceptance

Enable the GitHub App only for tt-a1i/archify, verify the OSS plan and a real PR review using this configuration, and evaluate 5–10 PRs for useful findings, false positives, review time, and repeated evidence requests before broadening use.

@tt-a1i

tt-a1i commented Sep 8, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: af6e7f54-58e4-4059-84d0-03e2abff8504

📥 Commits

Reviewing files that changed from the base of the PR and between 2ead014 and 6f6d77f.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • CONTRIBUTING.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Summary

Summary

This PR adds a bounded, advisory CodeRabbit review pilot.

  • Adds CodeRabbit configuration for reviews of non-draft and incremental changes.
  • Adds advisory checks for contribution scope and validation evidence.
  • Adds focused guidance for shared diagram code and packages.
  • Documents pilot use, evaluation criteria, manual review, and the pause switch.

The changes affect configuration and contributor documentation only. Existing CI, browser or perceptual acceptance, and maintainer approval remain authoritative. CodeRabbit requires separate GitHub App installation and onboarding.

Validation

The author reports passing YAML schema, property, guideline-path, advisory-settings, and git diff --check validation. Runtime and visual tests were not rerun because runtime and artifact inputs did not change.

At the current head, the working tree is clean and contains no diff to inspect. The reported validation results are therefore unverified here. Static checks do not establish browser or perceptual acceptance.

Walkthrough

The pull request adds CodeRabbit configuration and documents an automated review pilot in the contributing guide. The configuration defines review behavior, path-specific instructions, pre-merge checks, and local knowledge-base scopes.

Changes

Automated review pilot

Layer / File(s) Summary
Review pilot configuration and guidance
.coderabbit.yaml, CONTRIBUTING.md
Configures review language, profile, automation, disabled features, path-specific instructions, pre-merge checks, and knowledge-base scopes. Documents review triggers, draft handling, evidence requirements, maintainer assessment, and how to pause automatic reviews.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 6f6d7

This adds an advisory CodeRabbit pilot without changing runtime behavior or required CI. No actionable merge-blocking risk is established.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Contribution Scope ✅ Passed The PR meets the contribution-scope requirements. Its description states the maintainer problem, defines one focused CodeRabbit configuration and documentation slice, and references issue #344. It sta…
Validation Evidence ✅ Passed PASS. The committed diff adds only .coderabbit.yaml and a contributor-guide section; it changes no runtime, renderer, browser, or artifact inputs. The PR records exact schema/config validation comma…

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@tt-a1i

tt-a1i commented Sep 8, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai run pre-merge checks

The Tests run section now includes the exact executed validation commands, tool versions, schema hash, numeric results, and final-head CI link. Please reassess the existing evidence warning against the updated PR description; the code head is unchanged.

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
✅ Actions performed

Running Pre-merge checks. Results will be posted in the summary comment once complete.

@tt-a1i
tt-a1i merged commit 06bd6fe into main Sep 8, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant