Skip to content

AGENT.md #177

@helmut-hoffer-von-ankershoffen

Description

@claude

Create an comprehensive AGENT.md that helps you and other AI agents to write better code fully matching the principles of this repository, and best practices in the field. The AGENT.md must be a masterpiece as it relates to being concise, complete, useful, helpful, and understandable, by Agents and by Humans.

Tips on how to approach this:

  1. Inspecting all CLAUDE.md and other .md files in the project (e.g. README, CODE_STYLE, CONTRIBUTING, OPERATIONAL_EXCELLENCE)
  2. Inspect the full source code (in src/)
  3. Inspect the test code (in tests/)
  4. Inspect all configuration in the root directory of the repo, in particular the pyproject.yaml, noxfile.py, .pre-commit-config.yaml
  5. Inspect the Makefile and noxfile.py in the root directory, and the GitHub Actions and Workflows in the .github directory
  6. Read the latest commit messages
  7. Feel free to search the web for best practices how to construct an AGENT.md, and for enterprise coding and software architecture guidelines
  8. Think what information would help you most. I will later ask you to provide elegant and error free PRs.
  9. Think very deeply, take your time reasoning, make a plan, go in iterations

When you create the PR, add a "skip:test:long_running" label to the PR. Read the pyproject.toml for the why

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions