Skip to content

docs: add comprehensive agent documentation#8

Merged
mldangelo merged 1 commit intomainfrom
docs/add-agent-documentation
Jan 6, 2026
Merged

docs: add comprehensive agent documentation#8
mldangelo merged 1 commit intomainfrom
docs/add-agent-documentation

Conversation

@mldangelo
Copy link
Member

Summary

Adds comprehensive documentation for AI agents and developers working on the promptfoo-python repository.

Changes

New Files

  • AGENTS.md: Comprehensive documentation covering:

    • Repository overview and architecture
    • Development policies and procedures
    • Release process with release-please
    • CI/CD pipeline details
    • Code standards and quality tools
    • Testing strategy
    • Security practices (OIDC publishing)
    • Common development workflows
    • Troubleshooting and FAQ
  • CLAUDE.md: Simple pointer file (@AGENTS.md) for Claude Code context loading

Why This Matters

This documentation provides a single source of truth for:

  1. AI Agents: Clear guidance on development policies (always use PRs, conventional commits, etc.)
  2. Human Developers: Comprehensive reference for contributing to the project
  3. Maintainers: Documented processes for releases, CI/CD, and security

Key Policies Documented

  • ✅ Always create PRs, never commit to main
  • ✅ Use conventional commits for all changes
  • ✅ Follow semantic versioning (pre-1.0.0 rules)
  • ✅ Automated releases via release-please
  • ✅ Secure PyPI publishing via OIDC
  • ✅ Multi-platform testing requirements

Benefits

  • Ensures consistent development practices
  • Reduces onboarding time for new contributors
  • Documents tribal knowledge about the project
  • Provides troubleshooting guidance
  • Clarifies the automated release process

Review Notes

This is pure documentation - no code changes. Please review for:

  • Accuracy of documented processes
  • Completeness of coverage
  • Clarity for both AI and human readers

🤖 Generated with Claude Code

Add AGENTS.md with detailed documentation for AI agents and developers:
- Repository overview and architecture
- Development policies (PRs, conventional commits)
- Release process with release-please
- CI/CD pipeline details
- Code standards and testing strategy
- Security practices (OIDC for PyPI)
- Common development tasks and workflows
- FAQ section

Add CLAUDE.md as a pointer to AGENTS.md for Claude-specific context loading.

This documentation ensures consistent development practices and provides
comprehensive guidance for both AI agents and human developers working
on the repository.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@mldangelo mldangelo closed this in #7 Jan 6, 2026
@mldangelo mldangelo reopened this Jan 6, 2026
@mldangelo mldangelo merged commit a6037ff into main Jan 6, 2026
@mldangelo mldangelo deleted the docs/add-agent-documentation branch February 24, 2026 23:21
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