Skip to content

chore: add AI tooling config and conventional commits convention (JDWLABS-21)#1

Open
jdwillmsen wants to merge 3 commits into
mainfrom
chore/JDWLABS-21-ai-tooling
Open

chore: add AI tooling config and conventional commits convention (JDWLABS-21)#1
jdwillmsen wants to merge 3 commits into
mainfrom
chore/JDWLABS-21-ai-tooling

Conversation

@jdwillmsen
Copy link
Copy Markdown
Member

Summary

  • Add CLAUDE.md with ArgoCD/Helm structure, dev commands, and AI agent contract
  • Add GEMINI.md, AGENTS.md, .claude/settings.json, CONTRIBUTING.md, PR template
  • .claude/settings.json blocks argocd app sync and kubectl apply/delete

Jira

JDWLABS-21 — part of JDWLABS-14 (Org Health & Governance)

Test plan

  • Verify CLAUDE.md accurately reflects repo structure (argocd/, charts/)
  • Verify .claude/settings.json denies argocd app sync and kubectl delete

🤖 Generated with Claude Code

@jdwillmsen
Copy link
Copy Markdown
Member Author

Code review

Found 2 issues:

  1. CLAUDE.md "Key Files" section documents argocd/<app>/application.yaml and argocd/<app>/values.yaml, but the actual structure is argocd/<env>/config.yaml (e.g., argocd/non/config.yaml and argocd/prd/config.yaml). The README correctly describes the actual layout. An AI agent following the Key Files guidance will look for files that don't exist.

deployments/CLAUDE.md

Lines 74 to 77 in 4331852

- Read-only `kubectl get`, `kubectl describe`, `kubectl logs` are safe
- Never set ArgoCD Application `targetRevision` to a feature branch — always `HEAD` or a semver tag
- Never commit secrets — all secrets come from Vault via ExternalSecrets Operator

  1. AGENTS.md "Key Files" section has the same incorrect structure — documents argocd/<app>/application.yaml and argocd/<app>/values.yaml instead of the actual argocd/<env>/config.yaml pattern.

deployments/AGENTS.md

Lines 18 to 21 in 4331852

- `argocd/<app>/application.yaml` — ArgoCD Application manifest for that service
- `argocd/<app>/values.yaml` — Helm values override for that service
- `charts/<name>/Chart.yaml` — Helm chart metadata
- `charts/<name>/templates/` — Kubernetes manifest templates

🤖 Generated with Claude Code

- If this code review was useful, please react with 👍. Otherwise, react with 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant