Edit README.md to improve AI assistant guide for the codebase - #1032
Merged
Merged
Conversation
LeMurphant
requested changes
Jan 18, 2026
|
|
||
| ## Local Development Setup | ||
|
|
||
| 1. Copy `wrangler.toml.template` → `wrangler.toml` |
Collaborator
There was a problem hiding this comment.
These two lines are repeats from README.md, and I'm afraid that if the LLM reads them literally it could overwrite functional wrangler.toml files
| **Workaround:** Use `npm run dev` locally. CI builds on Linux. | ||
|
|
||
| ### 2. Prettier Formatting in PRs | ||
| CI enforces Prettier. If your PR fails with formatting errors: |
Collaborator
There was a problem hiding this comment.
My understanding is that prettier should be run before committing. If we forget, I tend to use git commit --amend --no-edit and git push --force-with-lease if it's been pushed already, but that's not ideal either.
| 1. Add/modify SVGs in `app/assets/icons/` | ||
| 2. Run `npm run generate-icons` | ||
|
|
||
| ### 4. wrangler.toml is Gitignored |
Collaborator
There was a problem hiding this comment.
The README specified this, I don't think it's needed here.
- Remove duplicate setup steps that could cause wrangler.toml overwrites - Rewrite Prettier section to emphasize pre-commit formatting - Remove redundant wrangler.toml gitignore note (already in README)
jrhender
changed the title
jrhender
approved these changes
Mar 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds an AGENTS.md file to help AI coding assistants (Claude, Gemini, GPT, etc.) quickly understand the stampy-ui codebase.
Contents
This should help onboard any AI assistant working on this repo.