The boilerplate's rule: the deploy kit's Dockerfile, the APP_CONFIG, APP_PASSWORD and APP_DATA variables and its commands all assume a package called app, so a project renames its display title and nothing else. The console script is `app`, and the launch entry runs `uv run app serve --port 8790`. The domain noun stays `role`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# Rule:
|
|
|
|
Committed in main, branch deleted means the work is done. Having code uncommitted or committed in a branch or worktree means you failed to deliver. Pushing is not a thing we really care about.
|
|
|
|
# Rule:
|
|
|
|
MDs dont have hard wraps. IF you come across one make it soft wrapping
|
|
|
|
# Rule:
|
|
|
|
In documentations so not write bloat like:
|
|
|
|
> The obvious objection, answered before it's asked. "They just open a new session." Yes. **That's friction, not a wall, and it's meant to be.**
|
|
|
|
Instead, write more concise, more technical English, e.g. :
|
|
|
|
> One objection is that they just open a new session. Yet, this friction is by design because ...
|
|
|
|
Bad Example:
|
|
|
|
> **Could we verify them first to save the human a step?** Only if the receiving system will accept our verification. If it re-authenticates anyway we've added a step to save none — worth asking in a real deployment, not worth assuming.
|
|
|
|
Good example:
|
|
|
|
> We should only verify them first, if the receiving system will accept our verification? Otherwise it double work for the customer.
|
|
|
|
|
|
# Rule:
|
|
|
|
The package is `app`, following the boilerplate: the deploy kit, `APP_CONFIG`, `APP_PASSWORD` and `APP_DATA` assume that name. The domain noun is `role`, so "job" only ever means queued work.
|
|
|
|
# Rule:
|
|
|
|
`pipeline/`, `auth/` and `deploy/` are downstream copies of `../boilerplate`, `desk/` of `../news`. They are refreshed with `git archive`, and a fix lands upstream first, otherwise the next refresh reverts it.
|