gpui-style-guide

Guide GPUI component structure, trait implementations, and naming conventions.

12.5k|757|Updated Jun 13, 2024
One-click install
npx skills add https://github.com/longbridge/gpui-component --skill gpui-style-guide-longbridge
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gpui-style-guide
Source: https://github.com/longbridge/gpui-component/tree/main/.claude/skills/gpui-style-guide
Command: npx skills add https://github.com/longbridge/gpui-component --skill gpui-style-guide-longbridge

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

GPUI Component project style guide ensures consistent component design and implementation across the codebase, reducing drift when adding or reviewing components.

Core Features & Use Cases

  • Documents component structure, trait implementations, naming conventions, and API patterns observed in gpui-component.
  • Serves as a reference for new component authors and code reviewers to align with established patterns.
  • Provides guidance for maintaining a coherent design system as the project evolves.

Quick Start

Consult this style guide when writing or reviewing GPUI components to align with existing gpui-component conventions.

Frequently Asked Questions about gpui-style-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the GPUI component conventions for structuring Rust code?

GPUI component conventions standardize Rust code by defining specific component structures, trait implementations, and naming conventions to ensure consistent API usage across the codebase.

How do I review GPUI components for consistent design patterns?

Review GPUI components by checking them against documented style guidelines for API patterns, trait implementations, and documentation standards observed in the gpui-component project.

Does the GPUI style guide define naming conventions for Rust traits?

Yes, the GPUI style guide defines naming conventions for Rust traits and components, codifying patterns to maintain a coherent design system as the project evolves.

What is the best way to maintain a coherent design system in GPUI?

Maintain a coherent GPUI design system by consulting a style guide that codifies component layout, trait implementations, and documentation standards to reduce drift when adding components.

Can I use this style guide for writing new GPUI components in Rust?

Yes, this style guide serves as a reference for new component authors writing Rust GPUI components, aligning them with established patterns and reducing structural drift.

When do I need a GPUI component style guide?

You need a GPUI component style guide when adding or reviewing components to ensure consistent design, reduce codebase drift, and align with established API patterns in Rust.