TopDogLabs/BusinessCard
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Signed-off-by: Matt Bruce <mbrucedogs@gmail.com>

Browse Source
This commit is contained in:
Matt Bruce 2026-01-10 15:29:22 -06:00
parent e673658516
commit 06c5d10baf
1 changed files with 10 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Agents.md
View File

@ -2,14 +2,15 @@
This repository contains an Xcode project written with Swift and SwiftUI. Please follow the guidelines below so that the development experience is built on modern, safe API usage. This repository contains an Xcode project written with Swift and SwiftUI. Please follow the guidelines below so that the development experience is built on modern, safe API usage.
## Additional Context Files (Read First) ## Additional Context Files
**These files are kept in sync and MUST be updated together when making changes:** Before starting work, read project documentation:
- `README.md` — Product scope, features, and project structure - `WORKSPACE.md` — (if present) Multi-project workspace overview and project relationships
- `ai_implementation.md` — AI implementation context and architecture notes - `README.md` — Project scope, features, and architecture
- In multi-project workspaces, each project folder has its own `README.md`
See **Documentation Instructions** section for mandatory sync requirements. When making architectural changes, keep documentation files in sync with code changes.
## Role ## Role
@ -731,36 +732,12 @@ Then clean build (⇧⌘K) and rebuild. Everything updates automatically—inclu
## Documentation Instructions ## Documentation Instructions
### MANDATORY: Keep Documentation Files in Sync - **Keep `README.md` files up to date** when adding new functionality.
- In multi-project workspaces, update the relevant project's `README.md`.
⚠️ **These three files MUST be updated together when making architectural changes:** - Document new features, settings, or mechanics in the appropriate README.
- Update documentation when modifying existing behavior.
| File | Purpose |
|------|---------|
| `Agents.md` | Agent instructions and coding standards |
| `README.md` | Product scope, features, and project structure |
| `ai_implementation.md` | AI implementation context and architecture notes |
**When to update all three:**
- Adding new features or services
- Changing architecture patterns (e.g., WatchConnectivity vs App Groups)
- Modifying model structure (e.g., adding/removing properties)
- Learning important lessons (e.g., watch embedding requirements)
- Changing project structure or file organization
**Update checklist:**
1. ✅ `Agents.md` — Add instructions/guidelines for the change
2. ✅ `README.md` — Update features, architecture, or structure sections
3. ✅ `ai_implementation.md` — Update models, services, files, or lessons learned
### General Documentation Rules
- **Keep `README.md` up to date** when adding new functionality.
- Document new features, settings, or mechanics in the README.
- Update the README when modifying existing behavior.
- Include configuration options and special interactions. - Include configuration options and special interactions.
- README updates should be part of the same commit as the feature. - README updates should be part of the same commit as the feature.
- Maintain a `ROADMAP.md` for tracking feature status.
## PR Instructions ## PR Instructions