From 1e65aadda9a153492c693200a371968dc22282b9 Mon Sep 17 00:00:00 2001 From: ReachableCEO Date: Thu, 11 Sep 2025 07:05:23 -0500 Subject: [PATCH] release: v0.0.3 --- AGENTS.md | 7 +++++++ BOOTSTRAP.md | 16 ++++++++++++++++ COMMON/README.md | 13 +++++++++++++ COMMON/bootstrap-cicd.md | 21 +++++++++++++++++++++ COMMON/docs-style.md | 8 ++++++++ 5 files changed, 65 insertions(+) create mode 100644 AGENTS.md create mode 100644 BOOTSTRAP.md create mode 100644 COMMON/README.md create mode 100644 COMMON/bootstrap-cicd.md create mode 100644 COMMON/docs-style.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..fb7c502 --- /dev/null +++ b/AGENTS.md @@ -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. diff --git a/BOOTSTRAP.md b/BOOTSTRAP.md new file mode 100644 index 0000000..5fc550c --- /dev/null +++ b/BOOTSTRAP.md @@ -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). + diff --git a/COMMON/README.md b/COMMON/README.md new file mode 100644 index 0000000..95c7fe1 --- /dev/null +++ b/COMMON/README.md @@ -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. diff --git a/COMMON/bootstrap-cicd.md b/COMMON/bootstrap-cicd.md new file mode 100644 index 0000000..25ee240 --- /dev/null +++ b/COMMON/bootstrap-cicd.md @@ -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. + diff --git a/COMMON/docs-style.md b/COMMON/docs-style.md new file mode 100644 index 0000000..8904a31 --- /dev/null +++ b/COMMON/docs-style.md @@ -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. +