docs: add AGENTS.md guide

[yaugenst-flex]

Greptile Overview

Greptile Summary

This PR adds a new AGENTS.md documentation file that provides comprehensive guidelines for AI agents and human contributors working with the tidy3d repository. The guide covers:

• First-time setup checklist with Poetry and pre-commit hooks
• Project structure navigation and documentation standards
• Development workflow using Poetry commands
• Coding style conventions (snake_case, PascalCase, Tidy3dBaseModel usage)
• Testing guidelines with pytest
• Schema regeneration process
• Commit and PR requirements including Conventional Commits and branch naming

The document serves as a centralized reference to help maintain consistency and quality across contributions.

Confidence Score: 5/5

• This PR is safe to merge with no risk
• This is a documentation-only addition that introduces a new AGENTS.md file with comprehensive repository guidelines. No code changes are involved, and the documentation appears well-structured and accurate based on the repository's existing configuration files
• No files require special attention

Important Files Changed

File Analysis

Filename	Score	Overview
AGENTS.md	5/5	New documentation guide for AI agents and contributors with repository workflow, tooling, and coding standards

Sequence Diagram

sequenceDiagram
    participant Dev as Developer/Agent
    participant Repo as Repository
    participant Poetry as Poetry (Dependency Mgmt)
    participant PreCommit as Pre-commit Hooks
    participant CI as CI/CD System
    
    Note over Dev,CI: Initial Setup
    Dev->>Repo: Clone repository
    Dev->>Poetry: poetry install --with dev
    Poetry-->>Dev: Install dependencies
    Dev->>PreCommit: poetry run pre-commit install
    PreCommit-->>Dev: Enable hooks
    Dev->>PreCommit: poetry run pre-commit run --all-files
    PreCommit-->>Dev: Sync with hook set
    Dev->>Poetry: poetry run pytest
    Poetry-->>Dev: Validate environment
    
    Note over Dev,CI: Development Workflow
    Dev->>Repo: Read AGENTS.md guidelines
    Dev->>Repo: Make code changes
    Dev->>PreCommit: Commit (auto-run hooks)
    PreCommit->>PreCommit: Run ruff format, ruff check, doc hooks
    PreCommit-->>Dev: Validation result
    Dev->>Poetry: poetry run pytest
    Poetry-->>Dev: Test results
    Dev->>PreCommit: poetry run pre-commit run --all-files
    PreCommit-->>Dev: Final validation
    
    Note over Dev,CI: Schema Updates (if needed)
    Dev->>Poetry: poetry run python scripts/regenerate_schema.py
    Poetry-->>Dev: Generate schema artifacts
    Dev->>Repo: Commit schema changes
    
    Note over Dev,CI: Pull Request
    Dev->>Repo: Create PR (Conventional Commit + Jira key)
    Repo->>CI: Trigger CI checks
    CI->>CI: Run pytest, pre-commit, schema validation
    CI-->>Repo: CI status
    Repo-->>Dev: PR ready for review

Loading

[greptile-apps]

_{1 file reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[github-actions]

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

No lines with coverage information in this diff.

[marcorudolphflex]

Have you made a quick test from a fresh repo with this agents.md which covers a task that relate to the instructions?

[yaugenst-flex]

Have you made a quick test from a fresh repo with this agents.md which covers a task that relate to the instructions?

i've been using variations of this file for a while :D i think it works well, but definitely makes sense to interate a bit. we should also just keep the instructions updated if anything doesnt seem to work well

[yaugenst-flex]

ok i think this is pretty safe to merge, we'll need to iterate on the instructions anyways if something feels off

[yaugenst-flex]

@daquinteroflex i also snuck in an update to the readme badges