Skip to content

AGENTS.md

Latest commit

 

History

History
48 lines (34 loc) · 1.55 KB

AGENTS.md

File metadata and controls

48 lines (34 loc) · 1.55 KB

.github

Purpose

Repository automation, contributor templates, and CI configuration for the project's GitHub presence.

Key Files

File Description
CODEOWNERS Review ownership rules
PULL_REQUEST_TEMPLATE.md Default PR template for contributors
conventional-commit-lint.yaml Conventional commit validation config
dependabot.yml Dependency update automation config

Subdirectories

Directory Purpose
ISSUE_TEMPLATE/ GitHub issue form definitions (see ISSUE_TEMPLATE/AGENTS.md)
actions/ Shared action assets such as spelling configuration (see actions/AGENTS.md)
workflows/ CI workflow definitions (see workflows/AGENTS.md)

For AI Agents

Working In This Directory

  • Treat this subtree as repository automation and governance, not runtime code.
  • Keep workflow names, triggers, and file paths synchronized with actual repo structure.

Testing Requirements

  • Validate YAML syntax and referenced scripts or paths after changes.

Common Patterns

  • Workflow files orchestrate the same checks documented for local development.

Dependencies

Internal

  • scripts/ contains many commands invoked by workflows.
  • Root packaging and test configuration in pyproject.toml drives several CI jobs.

External

  • GitHub Actions workflow syntax and marketplace actions.