chore(repo): clean root and move docs
- Move docs to docs/; keep areas for prompts only - Relocate Makefile to scripts/Makefile; update docs to use it - Move ci.Dockerfile to docker/ci.Dockerfile; update compose - Move commitlint config to .config and update hook - Remove root AGENTS.md (use area AGENTS.md)
This commit is contained in:
53
docs/RESUME.md
Normal file
53
docs/RESUME.md
Normal file
@@ -0,0 +1,53 @@
|
||||
Resume Guide
|
||||
|
||||
Purpose
|
||||
- Quick checklist to pick up work after restarting Codex CLI with expanded permissions.
|
||||
|
||||
Branches on remote
|
||||
- main (default), integration, release, bootstrap, bootstrap-cicd
|
||||
|
||||
1) Pull latest
|
||||
- git fetch --all --prune
|
||||
- git switch bootstrap && git pull
|
||||
- git switch bootstrap-cicd && git pull
|
||||
- git switch integration && git pull
|
||||
|
||||
2) Ensure Docker is available
|
||||
- Start Docker Desktop/daemon as needed
|
||||
|
||||
3) Install hooks locally
|
||||
- make -f scripts/Makefile hooks-setup
|
||||
|
||||
4) Run local checks (Docker-only)
|
||||
- git switch bootstrap && make -f scripts/Makefile quick && make -f scripts/Makefile build
|
||||
- git switch bootstrap-cicd && make -f scripts/Makefile quick && make -f scripts/Makefile build
|
||||
- Optional full pass: make -f scripts/Makefile check
|
||||
|
||||
5) Open PRs (when branches are green locally)
|
||||
- bootstrap → integration: https://git.knownelement.com/KNEL/LLMScaffolding/pulls/new/bootstrap
|
||||
- bootstrap-cicd → integration: https://git.knownelement.com/KNEL/LLMScaffolding/pulls/new/bootstrap-cicd
|
||||
|
||||
6) Merge to integration
|
||||
- Use squash merge, allow auto-merge on green where configured
|
||||
|
||||
7) Release to main
|
||||
- Open PR: integration → main (require 1 approval)
|
||||
- After merge, tag manually (until CI runners are enabled):
|
||||
- git switch main && git pull
|
||||
- TAG=$(date -u +"v%Y.%m.%d-%H%M")
|
||||
- git tag -a "$TAG" -m "Release $TAG"
|
||||
- git push origin "$TAG"
|
||||
- Optional: fast-forward release branch pointer:
|
||||
- git branch -f release main && git push -f origin release
|
||||
|
||||
8) Docs & parity
|
||||
- Git workflow: [docs/git-workflow.md](git-workflow.md)
|
||||
- Local CI parity: [docs/bootstrap-cicd.md](bootstrap-cicd.md)
|
||||
|
||||
9) Defer CI enablement for two weeks
|
||||
- Track in [docs/TODO.md](TODO.md): Revisit enabling runners and protected checks on 2025-09-24
|
||||
|
||||
10) Next tasks
|
||||
- Answer any outstanding questions in questions/*
|
||||
- On approval, implement further proposals and update instructions/*
|
||||
|
Reference in New Issue
Block a user