Skip to content

Petrinaut: Add AGENTS.md and point CLAUDE.md to it#8725

Open
kube wants to merge 1 commit into
mainfrom
fe/agents-md
Open

Petrinaut: Add AGENTS.md and point CLAUDE.md to it#8725
kube wants to merge 1 commit into
mainfrom
fe/agents-md

Conversation

@kube
Copy link
Copy Markdown
Collaborator

@kube kube commented May 17, 2026

🌟 What is the purpose of this PR?

🔗 Related links

  • ...

🚫 Blocked by

  • ...

🔍 What does this change?

  • ...

Pre-Merge Checklist 🚀

🚢 Has this modified a publishable library?

This PR:

  • does not modify any publishable blocks or libraries, or modifications do not need publishing
  • modifies an npm-publishable library and I have added a changeset file(s)
  • modifies a Cargo-publishable library and I have amended the version
  • modifies a Cargo-publishable library, but it is not yet ready to publish
  • modifies a block that will need publishing via GitHub action once merged
  • I am unsure / need advice

📜 Does this require a change to the docs?

The changes in this PR:

  • are internal and do not require a docs change
  • are in a state where docs changes are not yet required but will be
  • require changes to docs which are made as part of this PR
  • require changes to docs which are not made in this PR
    • Provide more detail here
  • I am unsure / need advice

🕸️ Does this require a change to the Turbo Graph?

The changes in this PR:

  • do not affect the execution graph
  • affected the execution graph, and the turbo.json's have been updated to reflect this
  • I am unsure / need advice

⚠️ Known issues

🐾 Next steps

🛡 What tests cover this?

❓ How to test this?

  1. Checkout the branch / view the deployment
  2. Try X
  3. Confirm that Y

📹 Demo

@vercel
Copy link
Copy Markdown

vercel Bot commented May 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hash Ready Ready Preview, Comment May 17, 2026 1:06am
petrinaut Ready Ready Preview, Comment May 17, 2026 1:06am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
hashdotdesign-tokens Ignored Ignored May 17, 2026 1:06am

@cursor
Copy link
Copy Markdown

cursor Bot commented May 17, 2026

PR Summary

Low Risk
Documentation-only change that adds contributor guidance and redirects the existing file; no runtime or build logic is affected.

Overview
Adds AGENTS.md to centralize Petrinaut contributor/agent guidance (stack, React Compiler memoization rules, commands, conventions).

Replaces the detailed content in CLAUDE.md with a single instruction to read AGENTS.md first.

Reviewed by Cursor Bugbot for commit d6a488c. Bugbot is set up for automated code reviews on this repo. Configure here.

@github-actions github-actions Bot added area/infra Relates to version control, CI, CD or IaC (area) area/libs Relates to first-party libraries/crates/packages (area) type/eng > frontend Owned by the @frontend team labels May 17, 2026
@augmentcode
Copy link
Copy Markdown

augmentcode Bot commented May 17, 2026

🤖 Augment PR Summary

Summary: Centralizes Petrinaut contributor/agent guidance into a dedicated AGENTS.md and turns CLAUDE.md into a simple pointer.

Changes:

  • Adds libs/@hashintel/petrinaut/AGENTS.md covering stack, React Compiler memoization guidance, common commands, and package conventions.
  • Replaces the previous detailed CLAUDE.md content with a single “read AGENTS first” directive to avoid duplication.

Technical Notes: Documentation-only change; no runtime/build behavior is modified.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode Bot left a comment

Choose a reason for hiding this comment

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

Review completed. 1 suggestion posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

- Styles via Panda CSS (`css()`, `cva()` from `@hashintel/ds-helpers/css`)
- No `@local/*` imports — this is a published package
- Prefix unused parameters with `_`
MANDATORY: Always read @AGENTS.md first.
Copy link
Copy Markdown

@augmentcode augmentcode Bot May 17, 2026

Choose a reason for hiding this comment

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

libs/@hashintel/petrinaut/CLAUDE.md:1: @AGENTS.md may be ambiguous with the repo-root AGENTS.md; consider referencing the package-local libs/@hashintel/petrinaut/AGENTS.md explicitly so contributors don’t end up reading the wrong guide.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/infra Relates to version control, CI, CD or IaC (area) area/libs Relates to first-party libraries/crates/packages (area) type/eng > frontend Owned by the @frontend team

Development

Successfully merging this pull request may close these issues.

1 participant