Skip to content

AGENTS.md

Latest commit

 

History

History
62 lines (46 loc) · 2.4 KB

AGENTS.md

File metadata and controls

62 lines (46 loc) · 2.4 KB

Agents Guidelines

Running tests

Use uv run for all commands run during tests. For example:

uv run pytest

Commit messages

Do not add Co-Authored-By headers in commit messages. Instead, use a Generated-by trailer following the guidelines of the ASF:

Generated-by: <Agent information>

Pull requests

Always use --web when creating PRs (e.g. gh pr create --web ...). This opens the PR in the browser and gives the author a chance to review the title, description, and diff before submitting. Do not create PRs directly from the CLI without --web.

PR templates

This repository uses multiple PR templates located in .github/PULL_REQUEST_TEMPLATE/:

  • action_approval.md — Use for requests to add a new GitHub Action to the allow list. Includes fields for the action name, URL, pinned version hash, permissions, related actions, and a review checklist.
  • code_change.md — Use for all other changes: new utilities, bug fixes, enhancements, workflow or CI changes, and documentation updates.

When creating a PR via gh pr create --web, GitHub will present a template chooser. Select the template that matches the type of change. When opening a PR URL directly, you can append &template=action_approval.md or &template=code_change.md to pre-fill the appropriate template.

License headers

All files must include the Apache License 2.0 header where the file format supports it. Use the appropriate comment syntax for the file type (e.g., <!-- --> for Markdown/HTML, # for YAML/Python, // for JavaScript/Go). See existing files in the repository for examples of the correct format.