mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-08 11:46:35 +00:00
26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
[Back to Frameworks](README.md)
|
|
|
|
# Makefile
|
|
|
|
Use this page for rules that shape the repository's `Makefile`.
|
|
|
|
The `Makefile` is the human-facing command surface for the repo. It should expose stable targets that people and CI are meant to run directly.
|
|
|
|
## Target Design
|
|
|
|
- Keep public targets stable, named clearly, and documented.
|
|
- Add a target only when a human operator or CI should run it directly.
|
|
- Keep helper-only logic, plumbing, and intermediate steps in `scripts/` or other implementation files.
|
|
- Prefer targets that compose smaller scripts instead of embedding large shell fragments in the `Makefile`.
|
|
- Keep the command surface small enough that contributors can discover the obvious path quickly.
|
|
|
|
## Repository Entry Points
|
|
|
|
The architecture overview treats `Makefile` and `scripts/` as the supported command entry points. The command groups themselves are documented here:
|
|
|
|
- [Development Environment Setup](../../setup.md)
|
|
- [Docker and Runtime Commands](../../tools/docker.md)
|
|
- [Testing and Validation](../../development/testing.md)
|
|
|
|
For the broader architecture context, see [Repository Architecture](../../architecture.md).
|