Scaffold the handbooks repo: scope, format convention, git-operations outline

Sibling store to halogen-workstation-roadmap's skills/ — instance-agnostic
reference material meant for KB admission, not for loading into context.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01YKviBjJejufEUmryJ42tLT
This commit is contained in:
2026-08-21 22:05:06 +09:00
commit 0ede23fdfe
2 changed files with 66 additions and 0 deletions
+32
View File
@@ -0,0 +1,32 @@
# Handbooks
Instance-agnostic reference material for coding agents — the verbose, citable kind that belongs in
a retrieval store, not in a skill.
## What goes here
- Public standards, style guides, and conventions that apply regardless of which box or project is
running — general git operations, language style guides, CERT/MISRA-style rulebooks.
- Long-form and specific. A handbook can be as detailed as it needs to be; nothing here is loaded
into a model's context wholesale, so length carries no per-turn tax.
## What does not go here
- **Anything specific to one machine or one project.** A local Gitea's branch-naming rule, this
box's PR checklist — that's instance-bound and belongs in that project's own KB corpus instead
(`kb-engineering` for [halogen](https://pi5-16.local/mikkeli/halogen-workstation-roadmap)).
- **Short, prescriptive procedures achievable within a context window or two.** That's a skill, not
a handbook — it gets loaded, not retrieved. See `skills/` in the halogen-workstation-roadmap repo
for the sibling convention.
- **The retrieval store itself.** This repo holds the source-of-truth markdown a human has vouched
for. The chunked, embedded index built from it is derived and rebuildable state — it lives beside
whichever KB is consuming it, never committed here.
## Format
One markdown file per topic at the repo root. Each file should stand as a single admittable
document — the same shape a human vouches for at KB admission time.
## Status
Started 2026-08-21. First handbook: general git operations.
+34
View File
@@ -0,0 +1,34 @@
# Git operations
> Draft outline — 2026-08-21. General practice, not tied to any one project's Gitea/GitHub setup.
## Scope
General git operations a coding agent should get right without being told each time: branching,
committing, merging vs. rebasing, and how to recover from the common ways each goes wrong. Anything
specific to one project's hosting setup (branch protection, PR template, CI triggers) belongs in
that project's own KB corpus instead — see this repo's README.
## Outline
- Branching
- naming conventions and when a new branch is warranted vs. not
- long-lived vs. short-lived branches
- Committing
- what makes a commit atomic; when to split or squash
- message conventions and what a good message actually needs to say
- Merging vs. rebasing
- when each is appropriate, and the history each produces
- conflict resolution — reading a conflict marker correctly, not guessing
- Reverting and undoing
- revert vs. reset vs. checkout — what each does to shared history
- recovering from a bad rebase or reset (reflog)
- Remotes and collaboration
- fetch vs. pull, and why the distinction matters under contention
- force-push: when it's ever appropriate, and how to do it without destroying someone else's work
- Tags and releases
- lightweight vs. annotated tags
- what a tag should mean once it's pushed
*(Fill in as it's composed. Each section should end up citable on its own — a chunk boundary, not
just a heading.)*