chore(ai instructions): claude and co-pilot instructions#664
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a canonical AGENTS.md document to centralize project conventions, operational notes, and AI-assistant guidance for the @epignosis_llc/gnosis React design system.
Changes:
- Introduces
AGENTS.mdwith local-dev commands, CI/validation workflow notes, and release conventions. - Documents architecture (folder structure, exports, path aliases), core patterns (theming, tokens, icons), and coding/testing conventions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+19
to
+23
| This file (`AGENTS.md`) is the canonical source. Other files exist only as discovery affordances for specific tools: | ||
|
|
||
| - `CLAUDE.md` — symlink to `AGENTS.md` so Claude Code finds the rules under its preferred filename. | ||
| - `.github/copilot-instructions.md` — symlink to `AGENTS.md` so GitHub Copilot auto-loads the rules. | ||
|
|
| - ❌ Adding React dependencies to the `/tokens` entry point — it must stay framework-agnostic. | ||
| - ❌ Shipping a component without a Storybook story. | ||
| - ❌ Vague PR titles — they become the squashed release commit. | ||
| - ❌ Ignoring ESLint/Prettier warnings. |
Collaborator
There was a problem hiding this comment.
- X 'as' usage, except 'as const'
Collaborator
Author
There was a problem hiding this comment.
| - Consumers override the theme by passing a partial `theme` to `ThemeProvider`, which `deepmerge`s it over the default — so every new theme value must have a sensible default. | ||
|
|
||
| **Design tokens** | ||
| - Raw, framework-agnostic tokens live in `src/theme/tokens.ts` / `tokens.css` and ship under the `/tokens` and `/tokens.css` entry points. These must stay React-free. Document any token additions in `DESIGN_TOKENS.md` (it is published-facing). |
Collaborator
There was a problem hiding this comment.
this will be removed by another pr
Collaborator
There was a problem hiding this comment.
Collaborator
Author
There was a problem hiding this comment.
marios-tsigkas
requested changes
Jun 25, 2026
xanderantoniadis
force-pushed
the
chore/create-ai-instructions
branch
from
June 25, 2026 15:45
b77dc87 to
8f1835c
Compare
epolikrati
approved these changes
Jun 26, 2026
|
🎉 This PR is included in version 6.7.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
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.
Added AI instructions.