Skip to content

docs: Add AGENTS.md for AI coding agent guidelines - #11

Merged
jatinkrmalik merged 2 commits into
mainfrom
docs/agents-md
Mar 5, 2026
Merged

docs: Add AGENTS.md for AI coding agent guidelines#11
jatinkrmalik merged 2 commits into
mainfrom
docs/agents-md

Conversation

@jatinkrmalik

Copy link
Copy Markdown
Member

Summary

Adds a comprehensive AGENTS.md file that provides context and guidelines for AI coding agents working in this repository.

Key Sections

  • 🚨 Critical Rule: Git Worktrees — Always use worktrees in /tmp/vocamac-* for parallel unrelated tasks. Never mess with the core workspace.
  • Repository Structure — Full directory layout with descriptions
  • Build & Run — All build, test, and run commands
  • Code Style — Swift conventions, architecture patterns, error handling, performance considerations
  • Testing Requirements — What to test, what not to test, naming conventions
  • Website — How the static site works, local testing, deployment
  • Git Workflow — Branch naming, commit messages (Conventional Commits), PR conventions
  • Dependencies — Key deps and version requirements
  • macOS Pitfalls — MenuBarExtra quirks, code signing, permissions, caching issues

Why

This ensures any AI coding session has the full context needed to:

  • Follow project conventions
  • Write good, tested code
  • Not corrupt the working directory when doing parallel work
  • Avoid known macOS/SwiftUI pitfalls we've already solved

Comprehensive guidelines for AI coding agents working in this repo:
- Critical rule: always use git worktrees for parallel tasks
- Repository structure and build commands
- Swift code style and architecture patterns
- Testing requirements and conventions
- Website development workflow
- Git branch naming and commit message conventions
- macOS-specific pitfalls and considerations
- Key dependencies and their purpose
@jatinkrmalik
jatinkrmalik merged commit 1f72ed4 into main Mar 5, 2026
1 check passed
@jatinkrmalik
jatinkrmalik deleted the docs/agents-md branch August 22, 2026 05:32
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