Adoption Quickstart
This page is the short path for adopting Brutal Honesty Kit v3.7.1 in another repository. The full install guide is v3.5/INSTALL.md.
1. Install Dependencies
From this repository:
python -m pip install -r v3.5/requirements.txt
Adopter repositories need the same runtime dependencies for the validator and schema checks.
2. Copy the Kit Surface
Use the copy steps in v3.5/INSTALL.md. The minimum install includes:
- rulebook under
docs/conventions/; docs/conventions/brutal-honesty-kit/v3.3/;docs/conventions/brutal-honesty-kit/v3.5/;scripts/validate_pr_brutal_honesty.py;scripts/check_block_flag.py;scripts/validate_v33_schema_drift.py;- smoke wrapper and one smoke-pipeline implementation;
- PR template or merge snippet;
- relevant tests and fixtures.
Keep the copied implementation path as v3.5/ unless you perform a full path
migration.
3. Choose the PR Template Path
If the adopter repo has no PR template, copy:
cp "$KIT/v3.5/templates/pr-body.md.template" .github/PULL_REQUEST_TEMPLATE.md
If the adopter repo already has a PR template, merge the snippet instead:
less "$KIT/v3.5/templates/pr-body-merge-instructions.md"
less "$KIT/v3.5/templates/pr-body-merge-snippet.md"
Do not overwrite an existing project-specific PR template without reviewing the lost content.
4. Add Optional Operator Tooling
For Claude Code users:
- copy
v3.5/hooks/check_brutal_honesty.pyand register it as a Stop hook; - copy
v3.5/commands/bhs-loop.mdandv3.5/commands/bhs-phased.mdinto.claude/commands/.
See hooks and commands.
5. Verify
From this repository, the focused release checks are:
cd v3.5
python -m pytest tests/test_validate_pr_brutal_honesty.py tests/test_v371_loophole_replay.py tests/test_r79_severity_cap.py tests/test_r80_rewrite_scope.py tests/test_check_brutal_honesty_hook.py -v
From an adopter repository, run the copied tests and validate one filled PR body before treating the install as active.