Skip to content

Conversation

@OscarCookeAbbott
Copy link
Contributor

Motivation

The current AGENTS.md file is very minimal and thus LLMs (Codelassian, Rovo Dev, etc) often need to be explicitly given more contextual information and/or spend more time/tokens finding it themselves to provide more useful results.

Changes

Expand AGENTS.md with more project information and guidelines on repository usage, file operations, communication style, code quality and task management.

Checklist

  • Existing or new tests cover this change
  • There is a changeset for this change, or one is not required
  • Added documentation for any new features to the docs/ folder

[no-changeset]: This is effectively just a documentation change

…, communication style, code quality and task management
@OscarCookeAbbott OscarCookeAbbott requested a review from a team as a code owner October 30, 2025 01:46
@changeset-bot
Copy link

changeset-bot bot commented Oct 30, 2025

⚠️ No Changeset found

Latest commit: b5e91cc

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 30, 2025

📊 Type Coverage Report

Coverage Comparison

Metric Baseline Current Change
Coverage Percentage 92.03% 92.03% ➡️ 0.00%
Correctly Typed 200,802 200,802 +0
Total Expressions 218,191 218,191 +0
Untyped Expressions 17,389 17,389 +0

Files with Most Type Issues (Top 15)

File Issues Affected Lines
packages/core/integration-tests/test/javascript.ts 983 648
packages/core/integration-tests/test/cache.ts 885 626
packages/core/integration-tests/test/scope-hoisting.ts 623 490
packages/utils/node-resolver-core/test/resolver.ts 476 177
packages/core/integration-tests/test/html.ts 468 294
packages/core/integration-tests/test/sourcemaps.ts 356 176
packages/core/test-utils/src/utils.ts 330 205
packages/core/integration-tests/test/incremental-bundling.ts 298 206
packages/core/core/src/dumpGraphToGraphViz.ts 251 108
packages/core/integration-tests/test/output-formats.ts 227 161
packages/transformers/webextension/src/WebExtensionTransformer.ts 210 80
packages/core/integration-tests/test/react-refresh.ts 197 71
packages/core/integration-tests/test/css-modules.ts 191 107
packages/core/core/src/requests/TargetRequest.ts 190 133
packages/core/integration-tests/test/babel.ts 187 115

This report was generated by the Type Coverage GitHub Action

Copy link
Contributor

@marcins marcins left a comment

Choose a reason for hiding this comment

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

Nice one! Left some comments.

Is there any issue with this file being so large in terms of "wasting" context or is that okay?


CI configuration: `.github/workflows/ci.yml`

### Git Workflow
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we make sure to always ask before creating a commit or pull request (I prefer to do these myself, for example).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep that is already included below

@OscarCookeAbbott
Copy link
Contributor Author

Nice one! Left some comments.

Is there any issue with this file being so large in terms of "wasting" context or is that okay?

All modern LLMs support 200k+ tokens, this document is currently only around 4k, and so combined with modern tooling of thread compression etc I think it should be fine. I do want to make another pass at clearing out unnecessary detail, redundancies etc to get it a bit lower though, ideally 2k I think.

@OscarCookeAbbott
Copy link
Contributor Author

I've just pushed fixes for the points raised in review as well a big refinement that brings the file down to around 3k tokens without sacrificing anything relevant to most agent work.

@OscarCookeAbbott OscarCookeAbbott enabled auto-merge (squash) November 10, 2025 03:45
@OscarCookeAbbott OscarCookeAbbott merged commit 5f75b1e into main Nov 12, 2025
25 of 26 checks passed
@OscarCookeAbbott OscarCookeAbbott deleted the oscar/improve-agents-md branch November 12, 2025 05:53
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.

5 participants