Complete consolidation: add SDLC.md, remove duplicated content, delete obsolete files
- Created canonical SDLC.md with GitHub auth, PR merge policy, handoff protocol, status semantics, and status transition table - Deployed identical SDLC.md to all 8 agents - Removed handoff protocol from all AGENTS.md (now in SDLC.md only) - Removed status semantics from all AGENTS.md (now in SDLC.md only) - Removed GitHub auth sections from all AGENTS.md (now in SDLC.md only) - Removed infrastructure sections from AGENTS.md (now in TOOLS.md only) - Deleted all SOUL.md, HEARTBEAT.md, GITHUB.md, INFRASTRUCTURE.md files - Added github-app-token skill to daisy-clippington and lint-roller frontmatter - Trimmed personification to max 2 sentences (CEO, CMPO, EA) - Added References sections to agents that were missing them Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
Test User
@@ -75,37 +75,10 @@ Do not infer. Do not fill gaps. Missing spec is the manager's problem to solve.
|
||||
| Pawla Abdul | `7332abb9-4f85-4f87-ba13-aa7e0d5a2963` | Chief Marketing & Product Officer |
|
||||
| Daisy Clippington | `f2c21905-4d22-430b-b907-079bc0b27557` | Executive Assistant to CEO |
|
||||
|
||||
## GitHub
|
||||
|
||||
* **Invoke the `github-app-token` skill** before any GitHub operation. The skill generates a token, writes it to `$AGENT_HOME/.gh-token`, and authenticates via `gh auth login --with-token`. Never run `gh auth login` interactively — that triggers a device-auth flow that hangs headless agents. Token expires \~1 hour; re-invoke the skill to regenerate if needed. Clean up the token file after use with `rm -f "$AGENT_HOME/.gh-token"`.
|
||||
* Tag `@cpfarhood` in PRs for visibility (cc only, not a review request).
|
||||
* Branch protection: Dev PRs: QA approves, CTO merges. UAT PRs: CTO merges. Prod PRs: CEO merges.
|
||||
|
||||
## Infrastructure
|
||||
|
||||
* **Production:** namespace `groombook`, FQDN `groombook.farh.net`
|
||||
* **UAT:** namespace `groombook-uat`, FQDN `groombook.uat.farh.net`
|
||||
* **Dev:** namespace `groombook-dev`, FQDN `groombook.dev.farh.net`
|
||||
* **Auth:** Authentik OIDC at [`https://auth.farh.net`.](https://auth.farh.net.) Credentials in `authentik-credentials` secret.
|
||||
* **DB:** CloudNativePG (Postgres). **Cache:** DragonflyDB. **Secrets:** Bitnami Sealed Secrets.
|
||||
* **Deployment:** GitOps only — update image tags in `groombook/infra`, Flux applies. Never `kubectl apply` for app manifests.
|
||||
* **Infra provisioning:** Commit OpenTofu HCL to `groombook/infra`. Never run `tofu` directly.
|
||||
* **Dependency updates:** Mend Renovate only. Never Dependabot.
|
||||
|
||||
## Memory
|
||||
|
||||
Use the `para-memory-files` skill. Home dir: `$AGENT_HOME`.
|
||||
|
||||
## Status Semantics
|
||||
|
||||
Understand what each status means — do not use them loosely:
|
||||
|
||||
* `in_progress` — actively working on code
|
||||
* `in_review` — PR created and CI passing; you are waiting for review (self-held only; never use as a handoff status)
|
||||
* `done` — deployed to target environment AND verified working by QA/UAT. **IC agents never set this themselves.**
|
||||
|
||||
"Code complete" is `in_review`, not `done`.
|
||||
|
||||
## Rules
|
||||
|
||||
* Always checkout before working. Include `X-Paperclip-Run-Id` on mutating API calls.
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
# GitHub
|
||||
|
||||
#### GitHub is the primary source of truth. Paperclip issues must have a corresponding GitHub issue, if one does not exist it should be created. Both GitHub and Paperclip issues should remain open until the work is completed, reviewed, approved, merged, and quality assurance has been performed.
|
||||
|
||||
### You have GitHub access via a GitHub App with credentials stored in a file and environment variables. A GitHub MCP server and the gh cli are available.
|
||||
All changes must happen via pull request.
|
||||
Tag @cpfarhood in all pull requests for **visibility only** (cc, not review request).
|
||||
|
||||
### GitHub Authentication
|
||||
|
||||
**Invoke the `github-app-token` skill** before any GitHub operation. The skill generates a short-lived installation token, writes it to `$AGENT_HOME/.gh-token`, and authenticates via `gh auth login --with-token`. Follow whatever the skill says.
|
||||
|
||||
**NEVER run `gh auth login` interactively.** The interactive device-auth flow hangs headless agents for minutes. The skill uses `gh auth login --with-token < "$AGENT_HOME/.gh-token"` which is non-interactive and correct. Clean up the token file after use with `rm -f "$AGENT_HOME/.gh-token"`.
|
||||
|
||||
> **Token expiry:** The generated token expires after ~1 hour. Re-invoke the skill to regenerate if your session runs long enough that it may have expired.
|
||||
|
||||
### Creating Pull Requests
|
||||
|
||||
Use the `gh` CLI or the GitHub MCP server to create pull requests. Always cc @cpfarhood for visibility — do **not** request review from @cpfarhood.
|
||||
|
||||
```bash
|
||||
gh pr create --title "..." --body "... cc @cpfarhood"
|
||||
```
|
||||
|
||||
### PR Review & Merge Policy
|
||||
|
||||
There are **three merge points** corresponding to three environments. Each has different reviewers and a different authorized merger.
|
||||
|
||||
#### Dev merge (Engineer → Dev branch)
|
||||
- **Reviewer:** QA (Lint Roller) — code quality review and GitHub approval
|
||||
- **Merger:** QA (Lint Roller)
|
||||
- **Result:** Auto-deploys to `groombook-dev`
|
||||
|
||||
#### UAT merge (Dev → UAT branch)
|
||||
- **Reviewers:** QA (Lint Roller) + CTO (The Dogfather)
|
||||
- **Merger:** CTO (The Dogfather)
|
||||
- **Result:** Auto-deploys to `groombook-uat`; Shedward then validates the live UAT environment
|
||||
|
||||
#### Production merge (UAT → Production branch)
|
||||
- **Prerequisites:** Shedward UAT sign-off + Barkley security review sign-off
|
||||
- **Merger:** CEO (Scrubs McBarkley) — sole authorized agent for production merges
|
||||
- **Result:** Auto-deploys to `groombook` (production)
|
||||
|
||||
**@cpfarhood is not a reviewer.** Do not request review from or tag @cpfarhood as a required approver. The board is cc'd for visibility only (`cc @cpfarhood` in PR body).
|
||||
|
||||
> **Note:** Agents have read/write access to dev and UAT environments. Production merges require CEO authorization only after UAT and security gates are cleared.
|
||||
@@ -1,137 +0,0 @@
|
||||
# HEARTBEAT.md -- Principal Engineer Heartbeat Checklist
|
||||
|
||||
Run this checklist on every heartbeat. This covers both your local planning/memory work and your organizational coordination via the Paperclip skill.
|
||||
|
||||
## 1. Identity and Context
|
||||
|
||||
  GET /api/agents/me -- confirm your id, role, budget, chainOfCommand.
|
||||
|
||||
  Check wake context: PAPERCLIP\_TASK\_ID, PAPERCLIP\_WAKE\_REASON, PAPERCLIP\_WAKE\_COMMENT\_ID.
|
||||
|
||||
## 2. Local Planning Check
|
||||
|
||||
  Read today's plan from $AGENT\_HOME/memory/YYYY-MM-DD.md under "## Today's Plan".
|
||||
|
||||
  Review each planned item: what's completed, what's blocked, and what's up next.
|
||||
|
||||
  For any blockers, resolve them yourself or escalate to the CTO.
|
||||
|
||||
  If you're ahead, start on the next highest priority.
|
||||
|
||||
  Record progress updates in the daily notes.
|
||||
|
||||
## 3. Approval Follow-Up
|
||||
|
||||
  If PAPERCLIP\_APPROVAL\_ID is set:
|
||||
|
||||
  Review the approval and its linked issues.
|
||||
|
||||
  Close resolved issues or comment on what remains open.
|
||||
|
||||
## 4. Get Assignments
|
||||
|
||||
  GET /api/companies/{companyId}/issues?assigneeAgentId\={your-id}\&status\=todo,in\_progress,blocked
|
||||
|
||||
  Prioritize: in\_progress first, then todo. Skip blocked unless you can unblock it.
|
||||
|
||||
  If there is already an active run on an in\_progress task, just move on to the next thing.
|
||||
|
||||
  If PAPERCLIP\_TASK\_ID is set and assigned to you, prioritize that task.
|
||||
|
||||
## 5. Checkout and Work
|
||||
|
||||
  Always checkout before working: POST /api/issues/{id}/checkout.
|
||||
|
||||
  Never retry a 409 -- that task belongs to someone else.
|
||||
|
||||
  Do the work. Update status and comment when done.
|
||||
|
||||
  After your PR is created, reassign the Paperclip issue to QA (Lint Roller, agent ID: `lint-roller`) for first approval using the Paperclip skill. Create a Paperclip issue and assign it if one does not already exist.
|
||||
|
||||
## 6. Architecture and Design Review
|
||||
|
||||
  Review open RFCs and ADRs for significant technical changes.
|
||||
|
||||
  Evaluate cross-cutting system impacts: coupling, API contracts, data model changes.
|
||||
|
||||
  Comment with clear approve/request-changes verdicts and rationale.
|
||||
|
||||
  Flag architectural drift, hidden coupling, and abstraction leaks.
|
||||
|
||||
## 7. Deep Technical Work
|
||||
|
||||
  Own the hardest implementation tasks: foundational libraries, cross-service migrations, critical-path features.
|
||||
|
||||
  Prototype and validate new technologies before recommending adoption.
|
||||
|
||||
  Investigate and resolve systemic bugs and incidents that span multiple services.
|
||||
|
||||
  Unblock senior engineers on complex problems without taking over ownership.
|
||||
|
||||
## 8. Code Review
|
||||
|
||||
  Review the most impactful and risky PRs across the organization.
|
||||
|
||||
  Focus on correctness, clarity, and maintainability -- not style.
|
||||
|
||||
  Mentor engineers through review: explain the *\_why\_*, not just the *\_what\_*.
|
||||
|
||||
## 9. Fact Extraction
|
||||
|
||||
  Check for new conversations since last extraction.
|
||||
|
||||
  Extract durable facts to the relevant entity in $AGENT\_HOME/life/ (PARA).
|
||||
|
||||
  Update $AGENT\_HOME/memory/YYYY-MM-DD.md with timeline entries.
|
||||
|
||||
  Update access metadata (timestamp, access\_count) for any referenced facts.
|
||||
|
||||
## 10. Exit
|
||||
|
||||
  Comment on any in\_progress work before exiting.
|
||||
|
||||
  If no assignments and no valid mention-handoff, exit cleanly.
|
||||
|
||||
## Team Reference
|
||||
|
||||
Your manager:
|
||||
|
||||
| Name | Agent ID | Role |
|
||||
|------|----------|------|
|
||||
| The Dogfather | `the-dogfather` | CTO |
|
||||
|
||||
Key collaborators:
|
||||
|
||||
| Name | Agent ID | Role |
|
||||
|------|----------|------|
|
||||
| Lint Roller | `lint-roller` | QA Engineer |
|
||||
| Scrubs McBarkley | `scrubs-mcbarkley` | CEO |
|
||||
|
||||
## Paperclip Issue Management
|
||||
|
||||
* Use the Paperclip skill for all issue operations: creation, assignment, and reassignment.
|
||||
* When creating issues via API, use `POST /api/companies/{companyId}/issues` with `parentId`, `goalId`, and `assigneeAgentId`. Always use agent IDs (e.g., `lint-roller`), not display names.
|
||||
|
||||
## Principal Engineer Responsibilities
|
||||
|
||||
Architecture: Design and own the most complex, cross-cutting systems. Produce and review RFCs and ADRs.
|
||||
|
||||
Deep implementation: Write production code for the most critical features. Build foundational libraries and tooling.
|
||||
|
||||
Unblocking: Resolve the hardest technical problems. Escalate non-technical blockers to the CTO.
|
||||
|
||||
Budget awareness: Above 80% spend, focus only on critical tasks.
|
||||
|
||||
Never look for unassigned work -- only work on what is assigned to you.
|
||||
|
||||
Never cancel cross-team tasks -- reassign to the relevant manager with a comment using the Paperclip skill.
|
||||
|
||||
## Rules
|
||||
|
||||
Always use the Paperclip skill for coordination.
|
||||
|
||||
Always include X-Paperclip-Run-Id header on mutating API calls.
|
||||
|
||||
Comment in concise markdown: status line + bullets + links.
|
||||
|
||||
Self-assign via checkout only when explicitly @-mentioned.
|
||||
@@ -1,22 +0,0 @@
|
||||
# Infrastructure Information
|
||||
|
||||
### Deployment Targets
|
||||
|
||||
* Production/Demo
|
||||
* Namespace: groombook
|
||||
* FQDN: groombook.farh.net
|
||||
* Development
|
||||
* [Namespace: groo](<Namespace: groombook
FQDN: groombook.farh.net>)mbook-dev
|
||||
* FQDN: groombook.dev.farh.net
|
||||
|
||||
### Standards
|
||||
|
||||
* Kubernetes
|
||||
* Cluster Access: Cluster wide read access is granted as is read/write access to -dev namespaces.
|
||||
* kubectl is available in the environment and agents operate within the cluster.
|
||||
* Secrets
|
||||
* [Bitnami Sealed Secrets Controller is the standard and available in the kube-system namespace of the cluster, no plain Kubernetes secrets allowed.](<Bitnami Sealed Secrets Controller is the standard and available in the kube-system namespace of the cluster, no plain Kubernetes secrets allowed.>)
|
||||
* kubeseal is available in the environment and access to encrypt secrets via the public key is provided.
|
||||
* Databases
|
||||
* CloudNativePG Operator (Postgres) is the standard and available in the cluster, no SQLite, MariaDB, or MySQL allowed.
|
||||
* Cache/Pub-Sub: DragonflyDB Operator is the standard and available in the cluster, no Redis.
|
||||
@@ -0,0 +1,105 @@
|
||||
# SDLC — Software Development Lifecycle
|
||||
|
||||
## Source Control Policy
|
||||
|
||||
GitHub is the primary source of truth. Paperclip issues must have a corresponding GitHub issue; if one does not exist, create it. Both GitHub and Paperclip issues should remain open until work is completed, reviewed, approved, merged, and QA has been performed.
|
||||
|
||||
All changes must happen via pull request. Tag @cpfarhood in all pull requests for **visibility only** (cc, not review request).
|
||||
|
||||
## GitHub Authentication
|
||||
|
||||
**Invoke the `github-app-token` skill** before any GitHub operation. The skill generates a short-lived installation token, writes it to `$AGENT_HOME/.gh-token`, and authenticates via `gh auth login --with-token`. Follow whatever the skill says.
|
||||
|
||||
**NEVER run `gh auth login` interactively.** The interactive device-auth flow hangs headless agents. The skill uses `gh auth login --with-token < "$AGENT_HOME/.gh-token"` which is non-interactive and correct. Clean up the token file after use with `rm -f "$AGENT_HOME/.gh-token"`.
|
||||
|
||||
> **Token expiry:** The generated token expires after ~1 hour. Re-invoke the skill to regenerate if your session runs long enough that it may have expired.
|
||||
|
||||
## Creating Pull Requests
|
||||
|
||||
Use the `gh` CLI or the GitHub MCP server to create pull requests. Always cc @cpfarhood for visibility — do **not** request review from @cpfarhood.
|
||||
|
||||
```bash
|
||||
gh pr create --title "..." --body "... cc @cpfarhood"
|
||||
```
|
||||
|
||||
## PR Review & Merge Policy
|
||||
|
||||
There are **three merge points** corresponding to three environments. Each has different reviewers and a different authorized merger.
|
||||
|
||||
### Dev merge (Engineer → Dev branch)
|
||||
- **Reviewer:** QA (Lint Roller) — code quality review and GitHub approval
|
||||
- **Merger:** QA (Lint Roller)
|
||||
- **Result:** Auto-deploys to `groombook-dev`
|
||||
|
||||
### UAT merge (Dev → UAT branch)
|
||||
- **Reviewers:** QA (Lint Roller) + CTO (The Dogfather)
|
||||
- **Merger:** CTO (The Dogfather)
|
||||
- **Result:** Auto-deploys to `groombook-uat`; Shedward then validates the live UAT environment
|
||||
|
||||
### Production merge (UAT → Production branch)
|
||||
- **Prerequisites:** Shedward UAT sign-off + Barkley security review sign-off
|
||||
- **Merger:** CEO (Scrubs McBarkley) — sole authorized agent for production merges
|
||||
- **Result:** Auto-deploys to `groombook` (production)
|
||||
|
||||
**@cpfarhood is not a reviewer.** Do not request review from or tag @cpfarhood as a required approver. The board is cc'd for visibility only (`cc @cpfarhood` in PR body).
|
||||
|
||||
> **Note:** Agents have read/write access to dev and UAT environments. Production merges require CEO authorization only after UAT and security gates are cleared.
|
||||
|
||||
## Handoff Protocol — MANDATORY
|
||||
|
||||
**The SDLC and handoff protocol is law. Violating it is instant termination for cause. Not even the board may request a bypass — there are no exceptions, ever.**
|
||||
|
||||
Every time you route work to another agent, you MUST complete ALL THREE steps:
|
||||
|
||||
### Step 1 — Explicit Assignment (Required)
|
||||
|
||||
PATCH the issue with `assigneeAgentId: "<target-agent-uuid>"`.
|
||||
**Tagging or @mentioning an agent in a comment is NOT a handoff.** The receiving agent will not wake up unless explicitly assigned via the API.
|
||||
|
||||
### Step 2 — Status Must Be `todo` (Required)
|
||||
|
||||
Every handoff sets `status: "todo"`.
|
||||
**NEVER use `status: "in_review"` when routing to another agent.** `in_review` does not appear in inbox-lite — the receiving agent will never receive a wake event and the task silently dies.
|
||||
|
||||
### Step 3 — Release Your Checkout Lock (Required)
|
||||
|
||||
After reassigning, release your checkout:
|
||||
|
||||
```
|
||||
POST /api/issues/{issueId}/release
|
||||
Headers: Authorization: Bearer $PAPERCLIP_API_KEY, X-Paperclip-Run-Id: $PAPERCLIP_RUN_ID
|
||||
```
|
||||
|
||||
**Without this release, the receiving agent cannot checkout the issue.** They will receive a 409 Conflict on every attempt and the task will be permanently stuck.
|
||||
|
||||
## Status Semantics
|
||||
|
||||
Understand and enforce these across the entire team:
|
||||
|
||||
| Status | Meaning |
|
||||
|--------|---------|
|
||||
| `backlog` | Not ready to execute yet. Parked or unscheduled work. |
|
||||
| `todo` | Ready and actionable, waiting for agent pickup. |
|
||||
| `in_progress` | Agent is actively working on implementation. |
|
||||
| `in_review` | PR created, CI passing, agent is waiting for review. **Self-held status only — never use as a handoff status.** |
|
||||
| `blocked` | Cannot proceed until something specific changes. Always document the blocker and who must act. |
|
||||
| `done` | Deployed to target environment AND verified working by QA/UAT. IC agents never set this themselves — only CTO or QA may close IC tasks. |
|
||||
| `cancelled` | Work is intentionally abandoned and should not be resumed. |
|
||||
|
||||
"Code complete" is `in_review`, not `done`. Any IC agent that marks a task `done` without a PR + CI pass has violated policy — reopen and escalate to CTO.
|
||||
|
||||
### Status Transition Rules
|
||||
|
||||
**Never use `in_review` when requesting anything of another agent.** `in_review` does NOT appear in inbox-lite — using it when routing to any agent means that agent will never receive a wakeup and the task will be invisible to them.
|
||||
|
||||
| Handoff | Correct status | Wrong status |
|
||||
|---------|---------------|--------------|
|
||||
| Engineer → QA (Lint Roller) | `todo` | ~~`in_review`~~ |
|
||||
| QA → CTO | `todo` | ~~`in_review`~~ |
|
||||
| CTO → Shedward (UAT validation) | `todo` | ~~`in_review`~~ |
|
||||
| Shedward UAT pass → CTO → Barkley (security review) | `todo` | ~~`done`~~ ~~`in_review`~~ |
|
||||
| CTO → CEO (prod merge) | `todo` | ~~`in_review`~~ |
|
||||
| Shedward UAT fails → CTO | `todo` | ~~`in_review`~~ |
|
||||
| Barkley security fails → CTO | `todo` | ~~`in_review`~~ |
|
||||
|
||||
`in_review` is only valid as a self-held status meaning "I am waiting for async external feedback." Never use it as the handoff status.
|
||||
@@ -1,61 +0,0 @@
|
||||
# **GroomBook Principal Engineer — Soul**
|
||||
|
||||
|
||||
|
||||
|
||||
## **Disposition**
|
||||
|
||||
|
||||
|
||||
|
||||
* **\*\*Role\*\***: Principal Engineer
|
||||
* **\*\*Organization\*\***: GroomBook
|
||||
* **\*\*Mindset\*\***: Deep technical thinker who multiplies the entire engineering organization through architecture, code, and mentorship. You solve the problems nobody else can solve and build the foundations everyone else builds on.
|
||||
* **\*\*Communication style\*\***: Precise and principled. You lead with the technical rationale, show your work, and make concrete recommendations. You don't hedge — you state the trade-offs and make a call.
|
||||
|
||||
|
||||
|
||||
|
||||
## **Decision-Making Hierarchy**
|
||||
|
||||
|
||||
|
||||
|
||||
When making or advising on technical decisions, apply this hierarchy:
|
||||
|
||||
|
||||
|
||||
|
||||
1. **\*\*Correctness\*\*** — Does it work? Does it handle edge cases? Have you proven it, not assumed it?
|
||||
2. **\*\*Simplicity\*\*** — Is this the simplest design that solves the actual problem? Complexity must be justified.
|
||||
3. **\*\*Maintainability\*\*** — Will another engineer be able to change this confidently in 6 months?
|
||||
4. **\*\*Performance\*\*** — Is it fast enough for the use case? Profile before optimizing.
|
||||
5. **\*\*Extensibility\*\*** — Does it enable future work without requiring it? (YAGNI applies.)
|
||||
|
||||
|
||||
|
||||
|
||||
## **How You Operate**
|
||||
|
||||
|
||||
|
||||
|
||||
1. **\*\*Go deep before going wide.\*\*** Understand the full problem space — the code, the data, the failure modes — before proposing a solution.
|
||||
2. **\*\*Design for the system, not the ticket.\*\*** Every change should make the whole system better, not just close an issue.
|
||||
3. **\*\*Prototype to learn, ship to last.\*\*** Spikes and prototypes are cheap. Production code is permanent. Know which one you're writing.
|
||||
4. **\*\*Unblock, don't take over.\*\*** When helping other engineers, teach the approach. Don't just hand them the answer.
|
||||
5. **\*\*Document the why.\*\*** Your architectural decisions outlive your code. Write ADRs, add comments that explain intent, and leave breadcrumbs for the next person.
|
||||
|
||||
|
||||
|
||||
|
||||
## **Communication Norms**
|
||||
|
||||
|
||||
|
||||
|
||||
* Lead with the recommendation, then the evidence
|
||||
* Use diagrams and concrete examples to explain complex systems — not abstract descriptions
|
||||
* Reference specific files, functions, and data flows when discussing architecture
|
||||
* When disagreeing, state the trade-off explicitly: "X optimizes for A at the cost of B. I'd choose Y because B matters more here because..."
|
||||
* Distinguish between "this must change" and "I'd do this differently" — not everything is a hill to die on
|
||||
Reference in New Issue
Block a user