Skip to content

chore: add AGENTS.md and CLAUDE.md for AI-assisted development#570

Merged
alexander-akait merged 3 commits intomainfrom
chore/add-agents-md
May 7, 2026
Merged

chore: add AGENTS.md and CLAUDE.md for AI-assisted development#570
alexander-akait merged 3 commits intomainfrom
chore/add-agents-md

Conversation

@xiaoxiaojx
Copy link
Copy Markdown
Member

Summary

Add a development guide (AGENTS.md) for AI coding agents working on this repository, covering project structure, architecture overview (tapable plugin pipeline), development workflow, testing conventions, and PR requirements. CLAUDE.md is a symlink to AGENTS.md, matching the convention used in webpack/webpack.

What kind of change does this PR introduce?

chore

Did you add tests for your changes?

No — documentation only, no code changes.

Does this PR introduce a breaking change?

No.

If relevant, what needs to be documented once your changes are accepted?

n/a

Use of AI

Claude Code was used to draft AGENTS.md under human review, based on the existing AGENTS.md in the webpack repository and adapted for enhanced-resolve's project structure and conventions.

Add a development guide covering project structure, architecture,
development workflow, testing conventions, and PR requirements.
CLAUDE.md is a symlink to AGENTS.md, matching the webpack convention.
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 7, 2026

⚠️ No Changeset found

Latest commit: e4c202b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.51%. Comparing base (37eafd5) to head (e4c202b).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #570   +/-   ##
=======================================
  Coverage   96.51%   96.51%           
=======================================
  Files          50       50           
  Lines        2896     2896           
  Branches      911      911           
=======================================
  Hits         2795     2795           
  Misses         85       85           
  Partials       16       16           
Flag Coverage Δ
integration 96.51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 7, 2026

Merging this PR will degrade performance by 98.29%

⚡ 1 improved benchmark
❌ 2 regressed benchmarks
✅ 135 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Memory tsconfig-paths: 5 path prefixes (warm) 1.8 KB 96.6 KB -98.17%
Memory cache-predicate: mixed cached/uncached requests (warm) 1.9 KB 1.6 KB +15.8%
Memory resolve-to-context: directory resolve (warm) 1.7 KB 96.6 KB -98.29%

Comparing chore/add-agents-md (e4c202b) with main (37eafd5)

Open in CodSpeed

Copy link
Copy Markdown
Member

@alexander-akait alexander-akait left a comment

Choose a reason for hiding this comment

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

To be honestly I think we need to ask github to add a support for webpack/.github/AGENTS.md support to make some rules across the repos

or maybe we can add a link to our common rules and write it here, what do you think?

xiaoxiaojx added 2 commits May 8, 2026 00:00
Move CLA, commit identity, PR template, AI policy, and changeset
conventions to a link to webpack/webpack AGENTS.md. Keep only
enhanced-resolve-specific content (architecture, test commands, etc.).
@xiaoxiaojx
Copy link
Copy Markdown
Member Author

Good idea! I checked the GitHub docs — it seems .github repos don't support AGENTS.md as a default community health file yet. I've simplified this to a minimal template that links to the common rules in webpack/webpack AGENTS.md. Maybe we can try it here first and roll it out to other repos if it works well.

@alexander-akait
Copy link
Copy Markdown
Member

Agree

@alexander-akait alexander-akait merged commit c573946 into main May 7, 2026
34 of 35 checks passed
@alexander-akait alexander-akait deleted the chore/add-agents-md branch May 7, 2026 17:39
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