docs: standardize repository helpers under tools

This commit is contained in:
Mikhail Chusavitin committed 2026-10-31 11:30:13 +03:00
1 parent 714447aa06
commit 3a6ee49c5c
4 files changed
+22 -4

No files matched your search

+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.