Skip to content

Conversation

@gchan
Copy link
Contributor

@gchan gchan commented Jan 28, 2026

Summary

Adds AGENTS.md file with comprehensive coding guidelines optimized for AI agents working on the buildkite-test-collector Python project.

Key Features:

  • Concise format: ~150 lines for quick reference
  • Complete build/test/lint commands: Including single test execution examples
  • Code style guidelines: Imports, formatting, type hints, naming conventions
  • Critical patterns: Frozen dataclasses with immutable state management
  • Testing conventions: pytest fixtures, @responses.activate for HTTP mocking
  • Pytest hook integration: Proper hook naming and documentation patterns
  • Common pitfalls: Most frequent mistakes to avoid
  • Release process: Step-by-step PyPI release workflow

This documentation helps AI coding agents understand the codebase conventions and work more effectively with the project.

Closes TE-5154

@gchan gchan changed the title Add AGENTS.md with coding guidelines for agents [TE-5154] Add AGENTS.md with coding guidelines for agents Jan 28, 2026
@gchan gchan requested a review from a team January 28, 2026 03:29
- Condensed format optimized for AI agents (~150 lines)
- Complete build/test/lint commands with single-test examples
- Code style guidelines: imports, formatting, type hints, naming
- Critical pattern: frozen dataclasses with immutable state management
- Testing conventions with @responses.activate for HTTP mocking
- Pytest hook integration patterns
- Common pitfalls and release process

Closes TE-5154
@gchan gchan force-pushed the te-5154-add-agentsmd-to-python-test-collector-repository branch from 12659c2 to 5ccebba Compare January 28, 2026 03:32
Copy link

@niceking niceking left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh nice!! Should we do the same for the other collectors / bktec?

@gchan
Copy link
Contributor Author

gchan commented Jan 28, 2026

Oh nice!! Should we do the same for the other collectors / bktec?

It wouldn't hurt!

@gchan gchan merged commit 6e50e59 into main Jan 28, 2026
10 checks passed
@gchan gchan deleted the te-5154-add-agentsmd-to-python-test-collector-repository branch January 28, 2026 20:19
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.

2 participants