Skip to content

Add AGENTS.md #232

@ncdorn

Description

@ncdorn

Problem

add an AGENTS.md or CLAUDE.md file to this repository to standardize development with AI agents and orient them to the repo structure. This is becoming standard practice in open-source codebases.

Solution

Something with a structure like this maybe:

Project overview

Brief purpose and main workflows.

Repo layout

Key directories and what they contain.

Development commands

install, Test, lint, format, type check, docs, examples.

Coding conventions

Style, architecture boundaries, naming, error handling.

Testing expectations

Which tests to run for different change types.

Documentation practices

style, format, "Write so that a new developer to this codebase can understand your writing, don’t assume your audience are experts in the topic/area you are writing about."

Pull request checklist

What must be true before submitting changes.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct and Contributing Guidelines

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions