Skip to content

docs: add AGENTS.md and CLAUDE.md for AI agents - #1868

Open
javier-aliaga wants to merge 1 commit into
dapr:masterfrom
javier-aliaga:docs/agents-md
Open

javier-aliaga wants to merge 1 commit into
dapr:masterfrom
javier-aliaga:docs/agents-md

Conversation

@javier-aliaga

Copy link
Copy Markdown
Contributor

Description

Adds an AGENTS.md with guidance for AI agents working on this repo, adapted from the one in dapr/python-sdk. CLAUDE.md only imports it.

It covers project structure, build and test commands, Checkstyle, license header, SpotBugs and JaCoCo gates, and how examples are validated with mechanical-markdown.

It also sets rules for when an agent may open a PR:

  • An agent works autonomously only on issues labeled ready-for-agent. A maintainer adds the label once the approach is settled.
  • Without the label, an agent works only for a human that a maintainer assigned the issue to. Self-assignment with /assign does not count.
  • If the change needs design decisions, at least one maintainer must approve the approach in the issue before the PR is opened.

The ready-for-agent label already exists in this repo.

Issue reference

None. This is a repo policy proposal for maintainers to discuss in this PR.

Checklist

  • Code compiles correctly (docs only)
  • Created/updated tests (n/a)
  • Extended the documentation

Adds agent guidance adapted from dapr/python-sdk: project structure,
build and test commands, quality gates, and examples validation.

Sets rules for opening PRs: agents work autonomously only on issues
labeled ready-for-agent; otherwise only for a human a maintainer
assigned the issue to. Changes that need design decisions require a
maintainer to approve the approach in the issue first.

Signed-off-by: Javier Aliaga <javier@diagrid.io>
@javier-aliaga
javier-aliaga requested review from a team as code owners October 25, 2026 11:07
Copilot AI lite review requested due to automatic review settings October 25, 2026 11:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@codecov

codecov Bot commented Oct 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.21%. Comparing base (15bec05) to head (0481fc7).

Additional details and impacted files
@@            Coverage Diff            @@
##             master    #1868   +/-   ##
=========================================
  Coverage     80.21%   80.21%           
  Complexity     2801     2801           
=========================================
  Files           273      273           
  Lines          8278     8278           
  Branches        896      896           
=========================================
  Hits           6640     6640           
  Misses         1272     1272           
  Partials        366      366           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This branch has not been deployed

No deployments
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.

3 participants