docs(repo): introduce code review instructions for copilot#2560
Merged
Conversation
✅ Deploy Preview for spirit-design-system-docsite ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for spirit-design-system-storybook canceled.
|
✅ Deploy Preview for spirit-design-system canceled.
|
github-actions
bot
added
the
maintenance
There was a problem hiding this comment.
Pull request overview
Updates the repository’s Copilot instructions to focus on concise, standardized PR review guidance, replacing the previously long set of component/system implementation guidelines.
Changes:
- Simplifies “Architecture & Technologies” headings and removes hardcoded version qualifiers (e.g., React/Node.js versions).
- Replaces large sections of component/dev/testing guidance with “Code Review Instructions” based on Conventional Comments.
- Adds review heuristics (what not to report, review dimensions, AI-generated code checks).
literat
force-pushed
the
chore/copilot-instructions
branch
from
284802f to
306dc05
Compare
crishpeen
approved these changes
Mar 31, 2026
* remove styling information, keep instructions short and sharp
literat
force-pushed
the
chore/copilot-instructions
branch
from
23961c9 to
5756dbf
Compare
adamkudrna
reviewed
Mar 31, 2026
Member
adamkudrna
left a comment
adamkudrna
left a comment
There was a problem hiding this comment.
Curious to see it in action!
| - **Accessibility tests** using jest-axe | ||
| - **Visual regression tests** with Playwright | ||
| - **Interaction tests** for user behaviors | ||
| When reviewing AI-generated changes, additionally check for: |
Member
There was a problem hiding this comment.
How do we know the code is (not) AI generated?
Collaborator
Author
There was a problem hiding this comment.
Good question. But as I remember it correctly, you have marked your AI-generated code with the comment :-)
| - **PascalCase** for React components (`Button`, `CardHeader`, `NavigationLink`) | ||
| - **Atomic design** structure (atoms, molecules, organisms) | ||
| - **Semantic versioning** with careful breaking change management | ||
| Use [Conventional Comments](https://conventionalcomments.org/) for all findings. |
Collaborator
Author
There was a problem hiding this comment.
You mean that the link should be formatted as we do it, or you are uncertain whether it will fetch and analyze the content?
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.
Description
Additional context
Issue reference