Skip to content

feat: add AGENTS.md project guide for agents#272

Merged
mj-kiwi merged 3 commits intomainfrom
feat/add-agents-md
Feb 24, 2026
Merged

feat: add AGENTS.md project guide for agents#272
mj-kiwi merged 3 commits intomainfrom
feat/add-agents-md

Conversation

@mj-kiwi
Copy link
Contributor

@mj-kiwi mj-kiwi commented Feb 18, 2026

Description

Add AGENTS.md file with comprehensive project guidelines for AI agents working on the snap-7715-permissions monorepo. This document provides essential information about the project structure, technology stack, build commands, code standards, testing patterns, error handling, security considerations, and troubleshooting tips.

The AGENTS.md follows the agents.md specification format, making it human-readable for agents while documenting best practices and development workflows specific to this ERC-7715 permissions implementation.

Related issues

Fixes:

Manual testing steps

  1. Review the AGENTS.md file for accuracy and completeness
  2. Verify all commands listed are correct by running them locally
  3. Check that code examples follow the project's actual patterns
  4. Confirm all referenced files and directories exist

Screenshots/Recordings

N/A - Documentation file

Before

No AGENTS.md file present in the repository.

After

Complete AGENTS.md file with project guidelines available at the repository root.

Pre-merge author checklist

  • I've followed MetaMask 7715 Permissions Snaps Contributor Docs and Coding Standards
  • I've completed the PR template to the best of my ability
  • I've included tests if applicable (N/A - documentation)
  • I've documented my code using JSDoc format if applicable (N/A - documentation)

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

Note

Low Risk
Documentation-only addition with no runtime, build, or dependency changes.

Overview
Adds a new root-level AGENTS.md document that standardizes agent-oriented guidance for this monorepo (architecture overview, required toolchain versions, common yarn workflows, env var setup, coding/testing conventions, and troubleshooting references).

Written by Cursor Bugbot for commit 2a77bcc. This will update automatically on new commits. Configure here.

@mj-kiwi mj-kiwi requested a review from a team as a code owner February 18, 2026 01:04
Copy link
Contributor

@jeffsmale90 jeffsmale90 left a comment

Choose a reason for hiding this comment

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

I'm loving this! We should get this across our other repositories asap!

@mj-kiwi mj-kiwi marked this pull request as draft February 18, 2026 01:28
- Remove "should" from test descriptions for clearer assertions
- Add directory paths for packages in Project Overview
- Replace in-memory caching guideline with batching RPC calls for better relevance

Addresses reviewer comments from PR #272
@mj-kiwi mj-kiwi marked this pull request as ready for review February 19, 2026 08:31
@mj-kiwi mj-kiwi requested a review from jeffsmale90 February 23, 2026 22:41
Copy link
Contributor

@jeffsmale90 jeffsmale90 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@mj-kiwi mj-kiwi merged commit dad2565 into main Feb 24, 2026
16 checks passed
@mj-kiwi mj-kiwi deleted the feat/add-agents-md branch February 24, 2026 02:29
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.

2 participants