4 Commits

Author SHA1 Message Date
1e65aadda9 release: v0.0.3
Some checks failed
Release / tag-and-notes (push) Has been cancelled
2025-09-11 07:05:23 -05:00
a00b6a8782 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)
2025-09-10 18:00:50 -05:00
d381070c75 release: v0.0.2
Some checks failed
Release / tag-and-notes (push) Has been cancelled
Squash-merge integration into main for v0.0.2
2025-09-10 22:47:49 +00:00
9cb1f5da1f Merge pull request 'release: merge integration into main' (#2) from integration into main
Some checks failed
Release / tag-and-notes (push) Has been cancelled
Reviewed-on: #2
2025-09-10 21:50:53 +00:00
15 changed files with 74 additions and 9 deletions

7
AGENTS.md Normal file
View File

@@ -0,0 +1,7 @@
Agent Guidance (Repo Base)
- Use area prompt packs generated under `dist/prompts/`:
- CTO: [dist/prompts/cto.md](dist/prompts/cto.md)
- COO: [dist/prompts/coo.md](dist/prompts/coo.md)
- To rebuild packs locally: `make prompts` (runs inside CI container).
- Keep prompts modular and concise; favor COMMON modules and minimal area deltas.

16
BOOTSTRAP.md Normal file
View File

@@ -0,0 +1,16 @@
The purpose of this repository is to create a re-usable set of prompts for use in AI chat intefaces and with agentic AI.
This file is being created at the very start of the repository in an attempt to provide full traceability. It will be passed to codex as a prompt.
Codex instructions:
- Remain in planning mode only. Ask questions and gather data.
- Create a propsoals directory and write out proposals to it for me to review and approve.
- Do not undertake any work unless I ask you for a proposal and I approve the proposal.
- Ask questions with numbers and allow them to be answered like 1:y 2:n or (for multiple choice) 1:a 2:b and so forth.
- Keep the chat message output short. Use proposal files that I can view in my editor (vsCode).
- The directory you are in is one level up from the git repository. This is so that git worktree can be used, to help mitigate issues with git branching. The repository is in a child directory called LLMScaffolding.
Your first concreate action:
- Please help me establish a git workflow (via the proposal/approval process I have outlined). This workflow should follow best practices, it should presume the use of CI/CD via Gitea (Gitlab/Github are banned, never produce anything for those platforms).

13
COMMON/README.md Normal file
View File

@@ -0,0 +1,13 @@
COMMON
Purpose
- Foundational, shared practices usable across projects.
- Opinionated but adaptable; intended as a base layer.
Contents (initial)
- Git workflow: [COMMON/git-workflow.md](git-workflow.md)
- CI/bootstrap parity: [COMMON/bootstrap-cicd.md](bootstrap-cicd.md)
- Documentation style: [COMMON/docs-style.md](docs-style.md)
Notes
- Keep content generic and reusable; project-specific overrides should live in the target repo.

21
COMMON/bootstrap-cicd.md Normal file
View File

@@ -0,0 +1,21 @@
Local CI Parity & Bootstrap
Purpose
- Provide a portable CI toolchain via a Dockerized image and compose file so that format/lint/build checks run identically locally and in CI.
Components
- `ci.Dockerfile` builds the CI image with shellcheck, shfmt, hadolint, actionlint, yamllint, Node tools.
- `docker/ci.compose.yml` runs the CI container mounting the repo at `/workspace`.
- `scripts/ci` wrapper for phases: `format`, `lint`, `build`, `test`, `security`, `all`.
- Git hooks `.githooks/*` installed via `scripts/setup-hooks`.
Usage
- Install hooks: `make hooks-setup`
- Quick checks: `make quick` (format + lint)
- Full pass: `make check` (all phases)
Notes
- Pre-commit hook runs format/lint and commit message checks.
- Pre-push hook runs build/test/security placeholders.
- CI workflow runs on integration and protected branches when runners are enabled.

8
COMMON/docs-style.md Normal file
View File

@@ -0,0 +1,8 @@
Documentation Style Guide
- When referencing another Markdown file in this repo, use a relative link so it is clickable in Gitea. Example: [COMMON/git-workflow.md](COMMON/git-workflow.md).
- Keep titles concise and descriptive; use sentence case unless a proper noun.
- Prefer short bullets (one point per line). Merge related points.
- Use backticks for commands, file paths, env vars, and code identifiers.
- Make documents actionable: lead with outcomes, then steps, then background.

View File

@@ -1,6 +1,6 @@
COO Agent Pack
Use the generated pack for agents: [dist/prompts/coo.md](dist/prompts/coo.md).
Use the generated pack for agents: [dist/prompts/coo.md](../../dist/prompts/coo.md).
Includes (via COMMON base):
- System persona, style, safety

View File

@@ -1,6 +1,6 @@
CTO Agent Pack
Use the generated pack for agents: [dist/prompts/cto.md](dist/prompts/cto.md).
Use the generated pack for agents: [dist/prompts/cto.md](../../dist/prompts/cto.md).
Includes (via COMMON base):
- System persona, style, safety

View File

@@ -7,8 +7,8 @@ Layout
- COMMON/ CTO/ COO/ CCO/ — questions, proposals, and prompt modules only
- scripts/ — Makefile and helper scripts
- docker/ — CI compose and Dockerfile
- CTO/dist/prompts/ and COO/dist/prompts/ — generated prompt packs
- COMMON/proposals/, COMMON/questions/ — planning artifacts
- dist/prompts/ — generated prompt packs (cto.md, coo.md)
- proposals/, questions/ — repository planning artifacts
Quickstart
- Install hooks: `make -f scripts/Makefile hooks-setup`

0
dist/prompts/coo.md vendored Normal file
View File

0
dist/prompts/cto.md vendored Normal file
View File

View File

@@ -12,7 +12,7 @@ TODO
- CI/CD bootstrap
- [x] Create branch bootstrap-cicd from main
- [x] Add questions at [COMMON/questions/bootstrap-cicd.md](../COMMON/questions/bootstrap-cicd.md)
- [x] Add questions at [questions/bootstrap-cicd.md](../questions/bootstrap-cicd.md)
- [x] Draft proposal based on answers
- [x] Implement parity tooling: scripts/ci, docker/ci.Dockerfile, docker/ci.compose.yml
- [x] Add .gitea/workflows: ci.yml, release.yml, nightly.yml

View File

@@ -28,11 +28,11 @@ ci_run() {
build_manifest() {
local manifest=$1 out=$2 root
root="$(repo_root)"
mkdir -p "$root/dist/prompts"
# Write on host to avoid ownership issues; container prints to stdout.
TMP_OUT=$(mktemp)
trap '[[ -n "${TMP_OUT:-}" ]] && rm -f "$TMP_OUT"' EXIT
ci_run "python3 scripts/prompt_build.py '$manifest' -" >"$TMP_OUT"
mkdir -p "$(dirname "$out")"
mv "$TMP_OUT" "$out"
}
@@ -44,12 +44,12 @@ case "$cmd" in
pack)
shift; area=${1:-}; root="$(repo_root)"
case "$area" in
cto) build_manifest "$root/COMMON/prompt/manifests/cto.yaml" "$root/CTO/dist/prompts/cto.md" ;;
coo) build_manifest "$root/COMMON/prompt/manifests/coo.yaml" "$root/COO/dist/prompts/coo.md" ;;
cto) build_manifest "$root/COMMON/prompt/manifests/cto.yaml" "$root/dist/prompts/cto.md" ;;
coo) build_manifest "$root/COMMON/prompt/manifests/coo.yaml" "$root/dist/prompts/coo.md" ;;
*) echo "Unknown area: $area" >&2; exit 2 ;;
esac ;;
all)
root="$(repo_root)"
root="$(repo_root)"; mkdir -p "$root/dist/prompts"
"$0" pack cto
"$0" pack coo ;;
lint)