Create AGENTS.md by bookernath · Pull Request #2561 · bigcommerce/catalyst

bookernath · 2025-08-27T15:20:56Z

What/Why?

Add an AGENTS.md file to help AI-assisted development tools in understand the structure of Catalyst as well as the best practices for extending it.

Testing

TBD - need to test various development scenarios

Migration

N/A

changeset-bot · 2025-08-27T15:21:01Z

⚠️ No Changeset found

Latest commit: 97ecdda

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

vercel · 2025-08-27T15:21:02Z

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

Project	Deployment	Preview	Comments	Updated (UTC)
catalyst-b2b	Ready	Preview	Comment	Nov 19, 2025 9:55pm
catalyst-canary	Ready	Preview	Comment	Nov 19, 2025 9:55pm

3 Skipped Deployments

Project	Deployment	Updated (UTC)
catalyst	Ignored	Nov 19, 2025 9:55pm
catalyst-au	Ignored	Nov 19, 2025 9:55pm
catalyst-uk	Ignored	Nov 19, 2025 9:55pm

Copilot

Pull Request Overview

This PR adds an AGENTS.md file to document the BigCommerce Catalyst codebase architecture for AI-assisted development tools. The documentation explains the custom middleware-based routing system that overrides Next.js defaults, data fetching patterns using Partial Prerendering (PPR), and the separated UI design system.

Added comprehensive documentation for the custom routing middleware that resolves URLs via GraphQL instead of file-based routing
Documented data fetching patterns including the Streamable utility and PPR configuration
Outlined the UI design system architecture with clear separation between business logic and presentation components

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

core/AGENTS.md

matthewvolk

I'm cool with merging so we can all collaborate and add to it, IMO it's already very valuable so far

core/AGENTS.md

matthewvolk · 2025-08-29T03:39:08Z

core/AGENTS.md

+
+1. **Use React's `cache()` function** for server-side data fetching to ensure deduplication.
+
+2. **Implement proper cache strategies** based on whether user authentication is present.


🍹 Do examples help here?

core/AGENTS.md

Co-Authored-By: Copilot <[email protected]>

Co-authored-by: Matthew Volk <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

core/AGENTS.md

Co-authored-by: Copilot <[email protected]>

@matthewvolk

* Create AGENTS.md Co-Authored-By: Copilot <[email protected]> * Apply suggestion from @matthewvolk Co-authored-by: Matthew Volk <[email protected]> * Apply suggestion from @matthewvolk Co-authored-by: Matthew Volk <[email protected]> * Update AGENTS.md * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Matthew Volk <[email protected]> Co-authored-by: Chancellor Clark <[email protected]>

@matthewvolk

* Create AGENTS.md Co-Authored-By: Copilot <[email protected]> * Apply suggestion from @matthewvolk Co-authored-by: Matthew Volk <[email protected]> * Apply suggestion from @matthewvolk Co-authored-by: Matthew Volk <[email protected]> * Update AGENTS.md * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Matthew Volk <[email protected]> Co-authored-by: Chancellor Clark <[email protected]>

bookernath force-pushed the initial-AGENTS.md branch from 31305de to 5ba2856 Compare August 27, 2025 15:23

bookernath requested a review from Copilot August 27, 2025 15:24

vercel bot deployed to Preview – catalyst-canary August 27, 2025 15:25 View deployment

vercel bot deployed to Preview – catalyst-b2b August 27, 2025 15:25 View deployment

Copilot AI reviewed Aug 27, 2025

View reviewed changes

bookernath force-pushed the initial-AGENTS.md branch from 72ce4b9 to bc9e3f0 Compare August 28, 2025 20:21

vercel bot deployed to Preview – catalyst-b2b August 28, 2025 20:22 View deployment

vercel bot deployed to Preview – catalyst-canary August 28, 2025 20:22 View deployment

matthewvolk approved these changes Aug 29, 2025

View reviewed changes

vercel bot deployed to Preview – catalyst-b2b September 4, 2025 03:40 View deployment

vercel bot deployed to Preview – catalyst-canary September 4, 2025 03:41 View deployment

vercel bot deployed to Preview – catalyst-b2b September 4, 2025 04:06 View deployment

vercel bot deployed to Preview – catalyst-canary September 4, 2025 04:06 View deployment

chanceaclark requested a review from Copilot November 19, 2025 21:40

bookernath and others added 4 commits November 19, 2025 14:40

Create AGENTS.md

37c7bdd

Co-Authored-By: Copilot <[email protected]>

Apply suggestion from @matthewvolk

1f0569b

Co-authored-by: Matthew Volk <[email protected]>

Apply suggestion from @matthewvolk

28a53ea

Co-authored-by: Matthew Volk <[email protected]>

Update AGENTS.md

0f00e77

chanceaclark force-pushed the initial-AGENTS.md branch from e7a6fc4 to 0f00e77 Compare November 19, 2025 21:40

Copilot started reviewing on behalf of chanceaclark November 19, 2025 21:40 View session

vercel bot deployed to Preview – catalyst-canary November 19, 2025 21:42 View deployment

vercel bot deployed to Preview – catalyst-b2b November 19, 2025 21:43 View deployment

Copilot finished reviewing on behalf of chanceaclark November 19, 2025 21:44

Copilot AI reviewed Nov 19, 2025

View reviewed changes

core/AGENTS.md Outdated Show resolved Hide resolved

core/AGENTS.md Outdated Show resolved Hide resolved

Apply suggestions from code review

97ecdda

Co-authored-by: Copilot <[email protected]>

vercel bot deployed to Preview – catalyst-canary November 19, 2025 21:55 View deployment

vercel bot deployed to Preview – catalyst-b2b November 19, 2025 21:55 View deployment

chanceaclark marked this pull request as ready for review November 19, 2025 21:57

chanceaclark requested a review from a team as a code owner November 19, 2025 21:57

chanceaclark added this pull request to the merge queue Nov 19, 2025

Merged via the queue into canary with commit 41ce193 Nov 19, 2025
12 checks passed

chanceaclark deleted the initial-AGENTS.md branch November 19, 2025 22:03


		1. Use React's `cache()` function for server-side data fetching to ensure deduplication.

		2. Implement proper cache strategies based on whether user authentication is present.

Conversation

bookernath commented Aug 27, 2025

What/Why?

Testing

Migration

Uh oh!

changeset-bot bot commented Aug 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Aug 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matthewvolk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

matthewvolk Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Aug 27, 2025 •

edited

Loading

vercel bot commented Aug 27, 2025 •

edited

Loading