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:
@@ -1,13 +0,0 @@
|
||||
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.
|
@@ -1,21 +0,0 @@
|
||||
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.
|
||||
|
@@ -1,8 +0,0 @@
|
||||
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.
|
||||
|
@@ -1,38 +0,0 @@
|
||||
Git Workflow – Finalized Instructions
|
||||
|
||||
Scope
|
||||
- Applies across projects. Contributors work via branches/PRs. CI/CD is Gitea‑native.
|
||||
|
||||
Branches
|
||||
- main: production; default branch. Protected.
|
||||
- integration: development (unprotected; merges auto on green).
|
||||
- Working branches: `feature/<topic>`, `fix/<topic>`, `chore/<topic>` from integration.
|
||||
- Hotfix: `hotfix/<date>` from main; PR back to main, then forward‑merge into integration.
|
||||
- Release branch: ephemeral or lightweight `release/*`. Protect when present; may fast‑forward to latest tag via CI.
|
||||
|
||||
Merges & Approvals
|
||||
- Feature → integration: squash merge; auto‑merge on green (no human approval). Self‑merge allowed.
|
||||
- integration → main: squash merge; require 1 approval; self‑merge not allowed.
|
||||
- Force pushes disabled on protected branches (`main`, `release/*`); PRs required.
|
||||
|
||||
Commit Style
|
||||
- Conventional Commits for PR titles and commit messages.
|
||||
|
||||
Versioning & Tags
|
||||
- Calendar tags: `vYYYY.MM.DD-HHMM` (UTC) for traceability.
|
||||
- Release tags: semantic or milestone tags (e.g., `v0.0.1-Bootstrap`).
|
||||
|
||||
Release Flow
|
||||
1) Feature branches PR into integration; checks pass → auto‑merge.
|
||||
2) PR integration → main; 1 approval required; on merge, deploy and tag release.
|
||||
3) Optional: CI fast‑forwards a `release` branch pointer to the new tag.
|
||||
|
||||
Protected Checks (enable when runners are ready)
|
||||
- On protected branches (`main`, `release/*`): ci / lint, ci / build, ci / commitlint. Add ci / test and ci / security when introduced.
|
||||
|
||||
CODEOWNERS
|
||||
- Keep minimal; require review for integration → main.
|
||||
|
||||
Notes
|
||||
- No secrets in this base repo. Future repos should integrate Vault for secrets.
|
||||
|
Reference in New Issue
Block a user