|
| 1 | +# Agents Guide (Central) |
| 2 | + |
| 3 | +## Overview |
| 4 | +This document provides AI coding assistants with essential context for working with the spendee-python-client project. |
| 5 | + |
| 6 | +## Development Environment Setup |
| 7 | +Please refer to the README.md for instructions on setting up the development environment. |
| 8 | + |
| 9 | +## Secrets Management |
| 10 | +We use Bitwarden for managing secrets. To access secrets, you will need the `BWS_ACCESS_TOKEN` environment variable set. You can then use the `bws` CLI to fetch secrets. |
| 11 | + |
| 12 | +**Example: Get a specific secret by key** |
| 13 | +```bash |
| 14 | +bws secret list | jq -r '.[] | select(.key == "spendee-password") | .value' |
| 15 | +``` |
| 16 | + |
| 17 | +**Example: List all secret keys** |
| 18 | +```bash |
| 19 | +bws secret list | jq -r '.[] | .key' |
| 20 | +``` |
| 21 | + |
| 22 | +## Living Documentation |
| 23 | +Important: The `agents.md` files are living documentation that should be updated alongside code changes. When implementing modifications: |
| 24 | + |
| 25 | +* **Update Relevant Agent Files:** Consider which `agents.md` files need updates when making changes. Avoid adding to the root agents.md file and use dedicated directory related agents.md. Only add the the root, when it is really globally applicable, otherwise just reference there. |
| 26 | +* **Keep Implementation Details Current:** Ensure commands, file paths, and procedures reflect the current state |
| 27 | +* **Maintain Cross-References:** Update links between agent files and documentation |
| 28 | +* **File References Only:** Never quote file content in agent files - only reference files by path |
| 29 | +* **Consistency:** Ensure terminology and patterns remain consistent across all agent files |
| 30 | + |
| 31 | +## Docs/Agents split policy |
| 32 | +* **Human docs (docs/**):** "What/Why"—architecture, domain flows, decisions, onboarding narratives, high-level troubleshooting flows. |
| 33 | +* **Agents (`agents.md` files):** "How"—exact files to touch, commands, env/secrets guidance, gotchas, safe-change checklists, Cursor-ready prompts. |
| 34 | + |
| 35 | +Each agent file starts with a "Read the overview" links block to the relevant `docs/**` pages. |
| 36 | + |
| 37 | +Each relevant `docs/**` page gets a small footer: "For implementation details, see `<path>/agents.md`". |
| 38 | + |
| 39 | +Reduce code/text duplication as much as possible across twin docs and agents files. |
0 commit comments