Skip to content

[create-cloudflare] Add best practices links to generated AGENTS.md#12563

Merged
petebacondarwin merged 2 commits intomainfrom
c3-agents-md-best-practices
Apr 15, 2026
Merged

[create-cloudflare] Add best practices links to generated AGENTS.md#12563
petebacondarwin merged 2 commits intomainfrom
c3-agents-md-best-practices

Conversation

@irvinebroque
Copy link
Copy Markdown
Contributor

@irvinebroque irvinebroque commented Feb 14, 2026

No associated issue — this is a small content improvement to the generated AGENTS.md.

Summary

Updates the AGENTS.md content generated by create-cloudflare for new Workers projects to direct AI coding agents to fetch and understand the latest best practices before writing any code. Adds links to:

These are placed in the preamble, immediately after the initial retrieval directive ("STOP. Your knowledge..."), so agents encounter them before any other guidance.


  • Tests
    • Tests included/updated
    • Automated tests not possible - manual testing has been completed as follows:
    • Additional testing not necessary because: existing tests pass — the test asserts the output of getAgentsMd() is written to disk without checking specific content
  • Public documentation
    • Cloudflare docs PR(s):
    • Documentation not necessary because: this change adds links to existing public documentation pages

Open with Devin

@irvinebroque irvinebroque requested a review from a team as a code owner February 14, 2026 23:21
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Feb 14, 2026

🦋 Changeset detected

Latest commit: 65cf460

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

@irvinebroque
Copy link
Copy Markdown
Contributor Author

/bonk are you able to review in this repository? if so please review

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 3 additional findings.

Open in Devin Review

@claude
Copy link
Copy Markdown
Contributor

claude bot commented Feb 14, 2026

Claude finished @irvinebroque's task —— View job


Changeset Review

  • Read changeset guidelines
  • Review changeset file
  • Post review results

All changesets look good

The changeset .changeset/agents-md-best-practices.md passes all validation criteria:

  • ✅ Version type: patch is appropriate for documentation improvements
  • ✅ Changelog quality: Clear, descriptive explanation of what's being added
  • ✅ Markdown headers: No h1/h2/h3 headers present
  • ✅ No analytics changes
  • ✅ Not a dependency update
  • ✅ Not an experimental feature

Comment thread packages/create-cloudflare/src/agents-md.ts Outdated
@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Feb 14, 2026

create-cloudflare

npm i https://pkg.pr.new/create-cloudflare@12563

@cloudflare/kv-asset-handler

npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@12563

miniflare

npm i https://pkg.pr.new/miniflare@12563

@cloudflare/pages-shared

npm i https://pkg.pr.new/@cloudflare/pages-shared@12563

@cloudflare/unenv-preset

npm i https://pkg.pr.new/@cloudflare/unenv-preset@12563

@cloudflare/vite-plugin

npm i https://pkg.pr.new/@cloudflare/vite-plugin@12563

@cloudflare/vitest-pool-workers

npm i https://pkg.pr.new/@cloudflare/vitest-pool-workers@12563

@cloudflare/workers-editor-shared

npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@12563

wrangler

npm i https://pkg.pr.new/wrangler@12563

commit: 65cf460

Direct AI coding agents to fetch Workers best practices, Durable Objects
rules, and Workflows rules before writing code in new projects.
…l references

Move Durable Objects and Workflows best practices links out of the
preamble and into a conditional section at the bottom of AGENTS.md.
These are now clearly marked as optional, only to be referenced if
the user's app uses those features.
@workers-devprod
Copy link
Copy Markdown
Contributor

workers-devprod commented Apr 15, 2026

Codeowners approval required for this PR:

  • ✅ @cloudflare/wrangler
Show detailed file reviewers

@github-actions
Copy link
Copy Markdown
Contributor

Changeset Review

File: .changeset/agents-md-best-practices.md

✅ All changesets look good

Summary:

  • Package: create-cloudflare
  • Version Type: patch (appropriate for this documentation enhancement)
  • Title: "Add best practices documentation links to generated AGENTS.md" - clear and descriptive
  • Body: Meaningfully explains the change and what's included
  • Headers: No h1/h2/h3 headers (compliant)
  • Analytics: Not applicable
  • Experimental: Not applicable

The changeset properly describes a small improvement to the AGENTS.md template that adds best practices documentation links for AI coding agents.

Copy link
Copy Markdown
Contributor

@workers-devprod workers-devprod left a comment

Choose a reason for hiding this comment

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

Codeowners reviews satisfied

@github-project-automation github-project-automation bot moved this from Untriaged to Approved in workers-sdk Apr 15, 2026
@petebacondarwin petebacondarwin merged commit a25270e into main Apr 15, 2026
56 checks passed
@github-project-automation github-project-automation bot moved this from Approved to Done in workers-sdk Apr 15, 2026
@petebacondarwin petebacondarwin deleted the c3-agents-md-best-practices branch April 15, 2026 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants