Standardize repository helper scripts under tools/ #1

Open
mchus wants to merge 1 commits from docs/tooling-directory into main
pull from: docs/tooling-directory
4 changed files with 22 additions and 4 deletions

No files matched your search

+1 -1
View File
@@ -20,7 +20,7 @@ If you are editing this `bible/` repository itself, read the target contract and
- Edit the relevant existing contract, or create a new `rules/patterns/<topic>/contract.md`.
- Normative rules go in `contract.md`; examples and rationale go in the pattern's `README.md`.
- Do not create rules outside `rules/patterns/`. Do not expand scope beyond engineering rules and patterns.
- Run `sh scripts/lint.sh` after changes.
- Run `sh tools/lint.sh` after changes.
## Always-On Contracts
+1 -1
View File
@@ -23,7 +23,7 @@ git submodule update --remote bible
AGENT-BOOTSTRAP.md — first file agents should read; contains the full contract router
rules/patterns/<topic>/ — one contract.md per topic (plus optional README.md with examples)
rules/ai/AGENT.template.md — template for new projects; copy as both CLAUDE.md and AGENTS.md
scripts/lint.sh — consistency checks (router coverage, broken links)
tools/lint.sh — consistency checks (router coverage, broken links)
```
## Project Setup
+19 -1
View File
@@ -1,6 +1,6 @@
# Contract: Module Atomicity
Version: 1.0
Version: 1.1
## Principle
@@ -34,3 +34,21 @@ Split a file when:
3. The file has more than one reason to change independently.
Do not wait until a file is "too big." Split at the moment the second responsibility appears.
## Repository Tooling
- Keep repository-owned helper programs and scripts under one root `tools/`
directory, regardless of language. Do not create parallel `scripts/`, `script/`
or `tool/` directories for the same purpose.
- Group a tool's supporting code, fixtures and usage notes with that tool;
use named subdirectories when several files implement one tool.
- Fixed-location integration entry points, such as Git hooks and CI workflow
files, stay where their runner requires them. Reusable helper logic belongs
in `tools/`. Application source and package-local test fixtures stay with
their owning packages.
- When moving an existing tool, update callers, CI, documentation and planned
paths together. Preserve executable permissions and repository-root resolution.
- Generated reports and logs are output artifacts, not tools. Keep them
untracked and document their output location. If the operator wants a report
beside the standalone script, ignore that report in Git. Credentials and
backup data must follow the applicable secrets and backup contracts.
+1 -1
View File
@@ -1,5 +1,5 @@
#!/bin/sh
# Consistency checks for the rules library. Run from the repo root: sh scripts/lint.sh
# Consistency checks for the rules library. Run from the repo root: sh tools/lint.sh
set -u
fail=0