mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 02:54:26 +00:00
kevinveenbirkenbachandClaude Sonnet 4.6
dca1eb69c7
Replace per-directory README.md index files with automatic glob toctree in root index.rst (docs/**). Add lint test that fails if any README.md appears under docs/. Document the no-README rule in documentation.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1.3 KiB
1.3 KiB
Code Quality
Use this page for repository-wide guidance on diff shape, readability, cleanup, and linting.
Diff Quality
- You MUST keep diffs focused, readable, and easy to review.
- You MUST NOT introduce duplicate, conflicting, or purely cosmetic churn unless formatting cleanup is part of the task.
- You SHOULD prefer semantic improvements that reduce maintenance effort.
Lint
You MUST use these linting and quality tools where applicable:
Repository Lint Rules
You MUST apply these repo-wide rules when you add, move, or review files:
- Keep broad folders shallow when that helps readability. Direct children SHOULD stay at 12 or fewer items per folder.
- Treat structural hubs such as
roles/,cli/,tests/unit/plugins/filter,tests/unit/roles,inventories/bundles/servers,inventories/bundles/workstations,plugins/filter,plugins/lookup,group_vars/all, and.github/workflowsas intentional exceptions when they are used to organize the tree. - You SHOULD prefer smaller, more focused folders over dumping many unrelated files into one directory.
For refactoring guidance, see Development.