-
Notifications
You must be signed in to change notification settings - Fork 36
chore: add vercel skills #997
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
carlosthe19916
wants to merge
1
commit into
guacsec:main
Choose a base branch
from
carlosthe19916:chore/vercel-skills
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # React Composition Patterns | ||
|
|
||
| A structured repository for React composition patterns that scale. These | ||
| patterns help avoid boolean prop proliferation by using compound components, | ||
| lifting state, and composing internals. | ||
|
|
||
| ## Structure | ||
|
|
||
| - `rules/` - Individual rule files (one per rule) | ||
| - `_sections.md` - Section metadata (titles, impacts, descriptions) | ||
| - `_template.md` - Template for creating new rules | ||
| - `area-description.md` - Individual rule files | ||
| - `metadata.json` - Document metadata (version, organization, abstract) | ||
| - **`AGENTS.md`** - Compiled output (generated) | ||
|
|
||
| ## Rules | ||
|
|
||
| ### Component Architecture (CRITICAL) | ||
|
|
||
| - `architecture-avoid-boolean-props.md` - Don't add boolean props to customize | ||
| behavior | ||
| - `architecture-compound-components.md` - Structure as compound components with | ||
| shared context | ||
|
|
||
| ### State Management (HIGH) | ||
|
|
||
| - `state-lift-state.md` - Lift state into provider components | ||
| - `state-context-interface.md` - Define clear context interfaces | ||
| (state/actions/meta) | ||
| - `state-decouple-implementation.md` - Decouple state management from UI | ||
|
|
||
| ### Implementation Patterns (MEDIUM) | ||
|
|
||
| - `patterns-children-over-render-props.md` - Prefer children over renderX props | ||
| - `patterns-explicit-variants.md` - Create explicit component variants | ||
|
|
||
| ## Core Principles | ||
|
|
||
| 1. **Composition over configuration** — Instead of adding props, let consumers | ||
| compose | ||
| 2. **Lift your state** — State in providers, not trapped in components | ||
| 3. **Compose your internals** — Subcomponents access context, not props | ||
| 4. **Explicit variants** — Create ThreadComposer, EditComposer, not Composer | ||
| with isThread | ||
|
|
||
| ## Creating a New Rule | ||
|
|
||
| 1. Copy `rules/_template.md` to `rules/area-description.md` | ||
| 2. Choose the appropriate area prefix: | ||
| - `architecture-` for Component Architecture | ||
| - `state-` for State Management | ||
| - `patterns-` for Implementation Patterns | ||
| 3. Fill in the frontmatter and content | ||
| 4. Ensure you have clear examples with explanations | ||
|
|
||
| ## Impact Levels | ||
|
|
||
| - `CRITICAL` - Foundational patterns, prevents unmaintainable code | ||
| - `HIGH` - Significant maintainability improvements | ||
| - `MEDIUM` - Good practices for cleaner code |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| name: vercel-composition-patterns | ||
| description: | ||
| React composition patterns that scale. Use when refactoring components with | ||
| boolean prop proliferation, building flexible component libraries, or | ||
| designing reusable APIs. Triggers on tasks involving compound components, | ||
| render props, context providers, or component architecture. Includes React 19 | ||
| API changes. | ||
| license: MIT | ||
| metadata: | ||
| author: vercel | ||
| version: '1.0.0' | ||
| --- | ||
|
|
||
| # React Composition Patterns | ||
|
|
||
| Composition patterns for building flexible, maintainable React components. Avoid | ||
| boolean prop proliferation by using compound components, lifting state, and | ||
| composing internals. These patterns make codebases easier for both humans and AI | ||
| agents to work with as they scale. | ||
|
|
||
| ## When to Apply | ||
|
|
||
| Reference these guidelines when: | ||
|
|
||
| - Refactoring components with many boolean props | ||
| - Building reusable component libraries | ||
| - Designing flexible component APIs | ||
| - Reviewing component architecture | ||
| - Working with compound components or context providers | ||
|
|
||
| ## Rule Categories by Priority | ||
|
|
||
| | Priority | Category | Impact | Prefix | | ||
| | -------- | ----------------------- | ------ | --------------- | | ||
| | 1 | Component Architecture | HIGH | `architecture-` | | ||
| | 2 | State Management | MEDIUM | `state-` | | ||
| | 3 | Implementation Patterns | MEDIUM | `patterns-` | | ||
| | 4 | React 19 APIs | MEDIUM | `react19-` | | ||
|
|
||
| ## Quick Reference | ||
|
|
||
| ### 1. Component Architecture (HIGH) | ||
|
|
||
| - `architecture-avoid-boolean-props` - Don't add boolean props to customize | ||
| behavior; use composition | ||
| - `architecture-compound-components` - Structure complex components with shared | ||
| context | ||
|
|
||
| ### 2. State Management (MEDIUM) | ||
|
|
||
| - `state-decouple-implementation` - Provider is the only place that knows how | ||
| state is managed | ||
| - `state-context-interface` - Define generic interface with state, actions, meta | ||
| for dependency injection | ||
| - `state-lift-state` - Move state into provider components for sibling access | ||
|
|
||
| ### 3. Implementation Patterns (MEDIUM) | ||
|
|
||
| - `patterns-explicit-variants` - Create explicit variant components instead of | ||
| boolean modes | ||
| - `patterns-children-over-render-props` - Use children for composition instead | ||
| of renderX props | ||
|
|
||
| ### 4. React 19 APIs (MEDIUM) | ||
|
|
||
| > **⚠️ React 19+ only.** Skip this section if using React 18 or earlier. | ||
|
|
||
| - `react19-no-forwardref` - Don't use `forwardRef`; use `use()` instead of `useContext()` | ||
|
|
||
| ## How to Use | ||
|
|
||
| Read individual rule files for detailed explanations and code examples: | ||
|
|
||
| ``` | ||
| rules/architecture-avoid-boolean-props.md | ||
| rules/state-context-interface.md | ||
| ``` | ||
|
|
||
| Each rule file contains: | ||
|
|
||
| - Brief explanation of why it matters | ||
| - Incorrect code example with explanation | ||
| - Correct code example with explanation | ||
| - Additional context and references | ||
|
|
||
| ## Full Compiled Document | ||
|
|
||
| For the complete guide with all rules expanded: `AGENTS.md` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "version": "1.0.0", | ||
| "organization": "Engineering", | ||
| "date": "January 2026", | ||
| "abstract": "Composition patterns for building flexible, maintainable React components. Avoid boolean prop proliferation by using compound components, lifting state, and composing internals. These patterns make codebases easier for both humans and AI agents to work with as they scale.", | ||
| "references": [ | ||
| "https://react.dev", | ||
| "https://react.dev/learn/passing-data-deeply-with-context", | ||
| "https://react.dev/reference/react/use" | ||
| ] | ||
| } |
29 changes: 29 additions & 0 deletions
29
.agents/skills/vercel-composition-patterns/rules/_sections.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Sections | ||
|
|
||
| This file defines all sections, their ordering, impact levels, and descriptions. | ||
| The section ID (in parentheses) is the filename prefix used to group rules. | ||
|
|
||
| --- | ||
|
|
||
| ## 1. Component Architecture (architecture) | ||
|
|
||
| **Impact:** HIGH | ||
| **Description:** Fundamental patterns for structuring components to avoid prop | ||
| proliferation and enable flexible composition. | ||
|
|
||
| ## 2. State Management (state) | ||
|
|
||
| **Impact:** MEDIUM | ||
| **Description:** Patterns for lifting state and managing shared context across | ||
| composed components. | ||
|
|
||
| ## 3. Implementation Patterns (patterns) | ||
|
|
||
| **Impact:** MEDIUM | ||
| **Description:** Specific techniques for implementing compound components and | ||
| context providers. | ||
|
|
||
| ## 4. React 19 APIs (react19) | ||
|
|
||
| **Impact:** MEDIUM | ||
| **Description:** React 19+ only. Don't use `forwardRef`; use `use()` instead of `useContext()`. |
24 changes: 24 additions & 0 deletions
24
.agents/skills/vercel-composition-patterns/rules/_template.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| title: Rule Title Here | ||
| impact: MEDIUM | ||
| impactDescription: brief description of impact | ||
| tags: composition, components | ||
| --- | ||
|
|
||
| ## Rule Title Here | ||
|
|
||
| Brief explanation of the rule and why it matters. | ||
|
|
||
| **Incorrect:** | ||
|
|
||
| ```tsx | ||
| // Bad code example | ||
| ``` | ||
|
|
||
| **Correct:** | ||
|
|
||
| ```tsx | ||
| // Good code example | ||
| ``` | ||
|
|
||
| Reference: [Link](https://example.com) |
100 changes: 100 additions & 0 deletions
100
...ts/skills/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| --- | ||
| title: Avoid Boolean Prop Proliferation | ||
| impact: CRITICAL | ||
| impactDescription: prevents unmaintainable component variants | ||
| tags: composition, props, architecture | ||
| --- | ||
|
|
||
| ## Avoid Boolean Prop Proliferation | ||
|
|
||
| Don't add boolean props like `isThread`, `isEditing`, `isDMThread` to customize | ||
| component behavior. Each boolean doubles possible states and creates | ||
| unmaintainable conditional logic. Use composition instead. | ||
|
|
||
| **Incorrect (boolean props create exponential complexity):** | ||
|
|
||
| ```tsx | ||
| function Composer({ | ||
| onSubmit, | ||
| isThread, | ||
| channelId, | ||
| isDMThread, | ||
| dmId, | ||
| isEditing, | ||
| isForwarding, | ||
| }: Props) { | ||
| return ( | ||
| <form> | ||
| <Header /> | ||
| <Input /> | ||
| {isDMThread ? ( | ||
| <AlsoSendToDMField id={dmId} /> | ||
| ) : isThread ? ( | ||
| <AlsoSendToChannelField id={channelId} /> | ||
| ) : null} | ||
| {isEditing ? ( | ||
| <EditActions /> | ||
| ) : isForwarding ? ( | ||
| <ForwardActions /> | ||
| ) : ( | ||
| <DefaultActions /> | ||
| )} | ||
| <Footer onSubmit={onSubmit} /> | ||
| </form> | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| **Correct (composition eliminates conditionals):** | ||
|
|
||
| ```tsx | ||
| // Channel composer | ||
| function ChannelComposer() { | ||
| return ( | ||
| <Composer.Frame> | ||
| <Composer.Header /> | ||
| <Composer.Input /> | ||
| <Composer.Footer> | ||
| <Composer.Attachments /> | ||
| <Composer.Formatting /> | ||
| <Composer.Emojis /> | ||
| <Composer.Submit /> | ||
| </Composer.Footer> | ||
| </Composer.Frame> | ||
| ) | ||
| } | ||
|
|
||
| // Thread composer - adds "also send to channel" field | ||
| function ThreadComposer({ channelId }: { channelId: string }) { | ||
| return ( | ||
| <Composer.Frame> | ||
| <Composer.Header /> | ||
| <Composer.Input /> | ||
| <AlsoSendToChannelField id={channelId} /> | ||
| <Composer.Footer> | ||
| <Composer.Formatting /> | ||
| <Composer.Emojis /> | ||
| <Composer.Submit /> | ||
| </Composer.Footer> | ||
| </Composer.Frame> | ||
| ) | ||
| } | ||
|
|
||
| // Edit composer - different footer actions | ||
| function EditComposer() { | ||
| return ( | ||
| <Composer.Frame> | ||
| <Composer.Input /> | ||
| <Composer.Footer> | ||
| <Composer.Formatting /> | ||
| <Composer.Emojis /> | ||
| <Composer.CancelEdit /> | ||
| <Composer.SaveEdit /> | ||
| </Composer.Footer> | ||
| </Composer.Frame> | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| Each variant is explicit about what it renders. We can share internals without | ||
| sharing a single monolithic parent. | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe adding set of skills from third parties could lead to the situation where new generated code by ai would not hold the same structure and patterns as already implemented human-generated code in this repo.
F.e this skills that have CRITICAL impact is avoiding boolean props like isEditing, isThread etc and uses composition instead.
I like composition pattern but as i see from a source code we didn't have a single component that uses composition and we have a bunch of components here that have boolean props.
Probably there are more examples like this.
And maybe there is not a bad thing that new code would be better than existing one, would use the best practices etc.
To be honest, i don't have a strong opinion on that just leaving my thoughts here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this is a good point. After skills like these ones are merged it is important to scan our repository and align it to the new skills so we don't see the scenario that you described.
Locally playing I already scanned the repository against the content of this PR and the result was: #999 -> this issue describe the road to align our code to the skills and good practices.
The old and the new code should match title by title, as mentioned above, an example of making the old code as good/bad as the new one is #999
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just wanted to add a note that just because we add these vercel skills to this repo doesn't mean we would need to keep them. We can decide to swap them out for other skills that better suit us later on.