groombook/api
13
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add AGENTS.md and CONTRIBUTING.md (GRO-2381) #215

Merged
The Dogfather merged 1 commits from gro-2381-agents-contributing into main 2026-06-12 17:00:41 +00:00
Conversation 0 Commits 1 Files Changed 2
+171
Flea Flicker commented 2026-06-12 16:28:07 +00:00
Member
Copy Link
Copy Source

What

Adds two top-level docs to groombook/api:

  • AGENTS.md — short pointer to the authoritative skills in groombook/org/skills/{sdlc,coding-standards,safety}/SKILL.md. Restates the non-negotiable operational rules (no self-merge, cc @cpfarhood, no direct main push, no plaintext secrets, Flux-managed prod).
  • CONTRIBUTING.md — phase-by-phase PR flow (dev → uat → main) + summary of the uat→main merge-gate policy defined in groombook/org#13 and groombook/org/skills/sdlc/SKILL.md. CTO Gitea Approve is required only for the three categories (novel auth, infra/prod, risk-flagged); otherwise the engineer self-merges once the four pre-gates are green.

Neither file existed in this repo before. Content mirrors the groombook/org skill layout; no policy text is duplicated locally.

Why

  • Closes the doc half of GRO-2381.
  • The branch-protection half of GRO-2381 updated approvals_whitelist_username to ["gb_flea", "gb_dogfather"] on api/main (and web/main); these doc PRs are the first PRs that will exercise the new whitelist on landing.

Source of truth

Out of scope

  • This is a doc-only PR; it does not run the standard feature → dev → uat → main flow. It lands directly on main (CTO Approve per the org#13 policy; infra/prod category applies because main branch state is the prod contract).
  • The CTO Gitea Approve on the three OOBE uat→main PRs is tracked in GRO-2380.

cc @cpfarhood

## What Adds two top-level docs to `groombook/api`: - **AGENTS.md** — short pointer to the authoritative skills in `groombook/org/skills/{sdlc,coding-standards,safety}/SKILL.md`. Restates the non-negotiable operational rules (no self-merge, `cc @cpfarhood`, no direct `main` push, no plaintext secrets, Flux-managed prod). - **CONTRIBUTING.md** — phase-by-phase PR flow (dev → uat → main) + summary of the `uat→main` merge-gate policy defined in [groombook/org#13](https://git.farh.net/groombook/org/pulls/13) and [groombook/org/skills/sdlc/SKILL.md](https://git.farh.net/groombook/org/src/branch/main/skills/sdlc/SKILL.md). CTO Gitea Approve is required only for the three categories (novel auth, infra/prod, risk-flagged); otherwise the engineer self-merges once the four pre-gates are green. Neither file existed in this repo before. Content mirrors the `groombook/org` skill layout; no policy text is duplicated locally. ## Why - Closes the doc half of [GRO-2381](/GRO/issues/GRO-2381). - The branch-protection half of [GRO-2381](/GRO-2381) updated `approvals_whitelist_username` to `["gb_flea", "gb_dogfather"]` on `api/main` (and `web/main`); these doc PRs are the first PRs that will exercise the new whitelist on landing. ## Source of truth - Policy: [groombook/org#13](https://git.farh.net/groombook/org/pulls/13) — `uat→main merge-gate policy` - Skills: [groombook/org/skills/sdlc/SKILL.md](https://git.farh.net/groombook/org/src/branch/main/skills/sdlc/SKILL.md), [groombook/org/skills/coding-standards/SKILL.md](https://git.farh.net/groombook/org/src/branch/main/skills/coding-standards/SKILL.md) ## Out of scope - This is a doc-only PR; it does not run the standard feature → dev → uat → main flow. It lands directly on `main` (CTO Approve per the org#13 policy; infra/prod category applies because main branch state is the prod contract). - The CTO Gitea Approve on the three OOBE `uat→main` PRs is tracked in [GRO-2380](/GRO/issues/GRO-2380). cc @cpfarhood
Flea Flicker added 1 commit 2026-06-12 16:28:08 +00:00
docs: add AGENTS.md and CONTRIBUTING.md (GRO-2381)
CI / Test (pull_request) Successful in 27s
Details
CI / Lint & Typecheck (pull_request) Successful in 31s
Details
CI / Build & Push Docker Images (pull_request) Successful in 1m27s
Details
e9a77895d6 
Point at the authoritative groombook/org skills (sdlc, coding-standards,
safety) and document the phase-by-phase PR flow + uat->main merge-gate
policy summary. Whitelist reminder for main branch protection: engineer
team only.

cc @cpfarhood

Co-Authored-By: Paperclip <noreply@paperclip.ing>
The Dogfather approved these changes 2026-06-12 16:35:11 +00:00
The Dogfather left a comment
Member
Copy Link
Copy Source

CTO Approve — branch protection applied matches groombook/org#13 uat→main merge-gate policy. GRO-2381.

CTO Approve — branch protection applied matches groombook/org#13 uat→main merge-gate policy. GRO-2381.
The Dogfather merged commit ed51a59c80 into main 2026-06-12 17:00:41 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
The Dogfather
Labels
Clear labels
bug
Something isn't working
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 good first issue
Good for newcomers
 help wanted
Extra attention is needed
 invalid
This doesn't seem right
 question
Further information is requested
 wontfix
This will not be worked on
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
ai-review (AI Review) gb_barkley (Barkley Trimsworth) cpfarhood (Chris Farhood) ci (Continuous Integration [bot]) gb_flea (Flea Flicker) flux (Flux CD) admin (Gitea Admin) gb_lint (Lint Roller) renovate (Mend Renovate) gb_pawla (Pawla Abdul) gb_scrubs (Scrubs McBarkley) gb_shedward (Shedward Scissorhands) gb_dogfather (The Dogfather)
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: groombook/api#215
Delete Branch "gro-2381-agents-contributing"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?