Add AGENTS.md project overview and dev guide #1302
Conversation
adrian-rpf
had a problem deploying
to
previews/1302/merge
GitHub Actions
Failure
Clarify development instructions in AGENTS.md: explicitly advise using `yarn install` when Yarn 3 is required, update Storybook URL to `http://localhost:6006/storybook/`, remove stale TODOs about Node version and GitHub Packages auth, and simplify the CHANGELOG requirement wording. Documentation-only changes to improve local dev setup clarity.
adrian-rpf
temporarily deployed
to
previews/1302/merge
GitHub Actions
Inactive
There was a problem hiding this comment.
Pull request overview
Adds an AGENTS.md guide to help contributors (and AI tooling) understand the repo’s structure, local dev workflow, testing/CI, and key conventions for the Raspberry Pi Code Editor web component.
Changes:
- Introduces
AGENTS.mdwith repository overview and quickstart commands - Documents testing/CI commands and local Cypress usage
- Captures styling/conventions and release/deploy pointers
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
adrian-rpf
temporarily deployed
to
previews/1302/merge
GitHub Actions
Inactive
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
adrian-rpf
temporarily deployed
to
previews/1302/merge
GitHub Actions
Inactive
adrian-rpf
temporarily deployed
to
previews/1302/merge
GitHub Actions
Inactive
adrian-rpf
temporarily deployed
to
previews/1302/merge
GitHub Actions
Inactive
AGENTS.md
Outdated
| <<<<<<< Updated upstream | ||
| - Node.js: use v18.17.1 locally (as pinned in `.tool-versions`). CI currently runs on Node 16, so avoid using Node APIs or syntax that are not supported in Node 16 until CI is updated or aligned. | ||
| - Yarn 3 is required (`packageManager` in `package.json`); `npm install` can fail - use `yarn install` instead. | ||
| ======= | ||
| - Yarn 4 is required (`packageManager` in `package.json`). If you don't have the right Yarn version available, run `corepack enable`. `npm install` can fail - use `yarn install` instead. | ||
| >>>>>>> Stashed changes |
There was a problem hiding this comment.
This conflict snuck through, might need to resolve it manually.
it is a little annoying to have to refer to and maintain the versions of things in another place- is the agent smart enough if we just say that we use the version of node specified in .tool-versions, and the yarn that's installed by corepack?
There was a problem hiding this comment.
Conflict fixed by AI as human was a muppet with simple commit.
Based on a few places it is recommended to reference the major version.
Be specific about your stack: Say “React 18 with TypeScript, Vite, and Tailwind CSS” not “React project.” Include versions and key dependencies.
https://github.blog/ai-and-ml/github-copilot/how-to-write-a-great-agents-md-lessons-from-over-2500-repositories/
zetter-rpf
left a comment
zetter-rpf
left a comment
There was a problem hiding this comment.
Left a couple of comments, but seems like a good start for us to try to use
…on to 4. Removed merge conflict markers. Addresses all issues
adrian-rpf
temporarily deployed
to
previews/1302/merge
GitHub Actions
Inactive
adrian-rpf
temporarily deployed
to
previews/1302/merge
GitHub Actions
Inactive
2 participants
No code changes but has impact on how AI tools work with this respository.
Points for consideration:
What's changed?
Steps to perform after deploying to production
AI Usage