mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-12 05:36:40 +00:00
- Move emojis after headline text (CONTRIBUTING.md, actions/, design/, tools/, tests/) - Replace em dashes with colons, semicolons, or complete sentences throughout - Add missing emojis to all headlines in exceptions.md, principles.md, services.md, shell.md, setup.md, pull-request.md, commit.md, act.md, docker.md, pr/README.md - Update H1 titles to reflect renamed directories (actions/, design/) - Fix broken relative links in workflow.md after directory moves - Fix full-path link texts in services.md (style.css.md, javascript.js.md) - Fix broken principles.md link to lint.md after testing/ → actions/testing/ move Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
18 lines
955 B
Markdown
18 lines
955 B
Markdown
# `Makefile` 🛠️
|
|
|
|
This page is the SPOT for rules that govern how the repository `Makefile` is written and structured.
|
|
For the full index of available `make` targets, see [make.md](../../tools/make.md).
|
|
|
|
## Target Design 📐
|
|
|
|
The `Makefile` is the human-facing command surface for the repo.
|
|
It MUST expose stable targets that people and CI are meant to run directly.
|
|
|
|
- You MUST keep public targets stable, named clearly, and documented.
|
|
- You MUST NOT add a target unless a human operator or CI should run it directly.
|
|
- You MUST keep helper-only logic, plumbing, and intermediate steps in `scripts/` or other implementation files.
|
|
- You SHOULD prefer targets that compose smaller scripts instead of embedding large shell fragments in the `Makefile`.
|
|
- You MUST keep the command surface small enough that contributors can discover the obvious path quickly.
|
|
|
|
For the broader architecture context, see [architecture.md](../../design/architecture.md).
|