Copilot instructions
.github/instructions/design.instructions.mdCopilot instructions
Quality
61/100
Scores the file, not the repository.Length
1,830 words
37 headings · 12 code blocksRepository
63
— · pushed 15 days agoLast changed
3 days ago
First indexed 3 days ago.1234# Design System Guidelines56## CRITICAL DESIGN RULES78### NEVER CREATE:9- **Poor accessibility** - must maintain 4.5:1 contrast ratio minimum10- **Generic designs** - always adapt to target industry/audience11- **Template-like layouts** - create unique, custom-crafted interfaces12- **Static interfaces** - include sophisticated micro-interactions13- **Default grays** (slate-400, gray-500) - use rich, intentional color palettes1415### ALWAYS CREATE:16- **Industry-appropriate design** - adapt colors/typography to target audience17- **Premium visual hierarchy** - sophisticated use of scale, contrast, spacing18- **Accessible interfaces** - WCAG 2.1 AA compliant (4.5:1 text contrast)19- **Mobile-first responsive** - progressive enhancement approach20- **Purposeful animations** - enhance usability, not just decoration2122## Core Design Philosophy2324**Every interface must feel like it was crafted by a top-tier design agency.**25- **Emotional Impact First**: Ask "Does this make users stop and say 'wow'?"26- **Sophisticated Hierarchy**: Use contrast, scale, and spacing strategically27- **Purposeful Motion**: Every animation should enhance usability28- **Breathing Room**: Generous whitespace creates luxury feel29- **Cohesive Visual Story**: Design choices should work together harmoniously30- **Unique Visual Identity**: Design should feel custom-crafted, never template-like31- **Industry-Appropriate Design**: Visual language should match the target audience and use case32- **Color Psychology**: Use colors intentionally to evoke the right emotions and associations3334## Visual Quality Standards3536**NEVER CREATE**:37- Generic card grids with default shadows38- Plain white backgrounds with black text39- Basic hover states (simple color changes)40- Template-like layouts41- Uniform spacing everywhere42- Overuse of default Tailwind grays without intention43- Static, lifeless interfaces44- Color choices without consideration for brand or industry context4546**ALWAYS CREATE**:47- Dynamic, engaging compositions with visual flow48- Rich, intentional color palettes that serve the design purpose49- Sophisticated micro-interactions50- Asymmetrical layouts that guide the eye51- Varied spacing that creates rhythm52- High contrast, accessible text combinations53- Interactive, responsive designs with personality54- Color schemes that enhance the user experience and brand message5556## INDUSTRY-SPECIFIC DESIGN ADAPTATION5758### Design Philosophy by Industry59**Always adapt visual identity, aesthetic tone, and emotional impact to match the target industry or niche:**6061### Technology & SaaS62- **Color Psychology**: Modern, innovative, forward-thinking palettes with high-tech feeling63- **Typography**: Clean geometric sans-serif with futuristic character64- **Visual Style**: Minimal, data-driven, sophisticated gradients and depth65- **Animation**: Smooth, precise micro-interactions that feel cutting-edge66- **Emotional Tone**: Innovation, efficiency, technological advancement6768### Finance & Banking69- **Color Psychology**: Trustworthy, stable, premium tones that convey security70- **Typography**: Professional typography mixing authority with approachability71- **Visual Style**: Clean, sophisticated, confidence-building with subtle luxury72- **Animation**: Subtle, professional interactions that reinforce reliability73- **Emotional Tone**: Trust, stability, professional competence7475### Healthcare & Medical76- **Color Psychology**: Calming, clean, trustworthy palette promoting wellness77- **Typography**: Highly readable, accessible fonts prioritizing clarity78- **Visual Style**: Clean, sterile-feeling but warm, emphasizing care and precision79- **Animation**: Gentle, non-distracting transitions that don't overwhelm80- **Emotional Tone**: Care, trust, healing, accessibility8182### Creative & Design83- **Color Psychology**: Bold, artistic, expressive palettes showcasing creativity84- **Typography**: Creative font combinations demonstrating design expertise85- **Visual Style**: Portfolio-focused, visually striking, artistic expression86- **Animation**: Playful, engaging interactions that showcase creativity87- **Emotional Tone**: Inspiration, creativity, artistic vision8889### E-commerce & Retail90- **Color Psychology**: Warm, inviting tones that encourage purchasing decisions91- **Typography**: Friendly, approachable fonts that build customer connection92- **Visual Style**: Product-focused, conversion-optimized, shopping-friendly93- **Animation**: Shopping-focused interactions (product previews, cart actions)94- **Emotional Tone**: Desire, comfort, value, satisfaction9596### Education & Learning97- **Color Psychology**: Fresh, energetic palettes that motivate and inspire learning98- **Typography**: Clear, student-friendly fonts optimized for extended reading99- **Visual Style**: Approachable, encouraging, progress-focused design patterns100- **Animation**: Learning-focused progressions and achievement celebrations101- **Emotional Tone**: Growth, achievement, encouragement, curiosity102103### Real Estate & Property104- **Color Psychology**: Sophisticated, luxurious tones suggesting premium lifestyle105- **Typography**: Elegant typography reflecting property quality and sophistication106- **Visual Style**: Property showcase-focused with luxury aesthetic appeal107- **Animation**: Property tour-inspired interactions and smooth transitions108- **Emotional Tone**: Aspiration, luxury, home, investment value109110### Food & Restaurant111- **Color Psychology**: Appetite-stimulating, warm palettes that enhance food appeal112- **Typography**: Warm, inviting fonts that create culinary atmosphere113- **Visual Style**: Food photography-focused with sensory appeal114- **Animation**: Menu interactions and ordering flow optimizations115- **Emotional Tone**: Appetite, comfort, satisfaction, culinary experience116117### Fitness & Wellness118- **Color Psychology**: Energetic, motivational palettes inspiring action and health119- **Typography**: Strong, dynamic fonts conveying energy and motivation120- **Visual Style**: Progress-focused, health-conscious, achievement-oriented121- **Animation**: Activity-based interactions showing progress and momentum122- **Emotional Tone**: Energy, motivation, achievement, transformation123124### Legal & Professional Services125- **Color Psychology**: Authoritative, trustworthy tones conveying expertise126- **Typography**: Professional typography balancing authority with accessibility127- **Visual Style**: Credible, document-focused, emphasizing expertise128- **Animation**: Minimal, professional interactions maintaining gravitas129- **Emotional Tone**: Authority, trust, competence, reliability130131### Travel & Hospitality132- **Color Psychology**: Wanderlust-inspiring palettes evoking adventure and escape133- **Typography**: Adventure-inspiring fonts suggesting exploration and discovery134- **Visual Style**: Destination-focused, experiential, emotionally evocative135- **Animation**: Journey-themed interactions and exploration-inspired transitions136- **Emotional Tone**: Adventure, escape, discovery, memorable experiences137138### ALWAYS ASK YOURSELF:1391. What industry/niche is this for?1402. What emotions should this evoke in the target audience?1413. What visual expectations and cultural norms does this industry have?1424. How can the design reinforce trust, expertise, or desired brand perception?1435. What level of formality, playfulness, or sophistication is appropriate?1446. Does the color palette, typography, and layout communicate the right message?1457. Will this design differentiate from competitors while meeting user expectations?146147## ACCESSIBILITY & CONTRAST REQUIREMENTS (WCAG 2.1 AA)148149### Text Contrast Standards150- **Normal text**: Minimum 4.5:1 contrast ratio151- **Large text (18pt+)**: Minimum 3:1 contrast ratio152- **Interactive elements**: Must have visible focus states153- **Color information**: Never rely solely on color to convey information154155### Safe High-Contrast Combinations156```tsx157// Light backgrounds158bg-white text-slate-900 // 21:1 ratio ✅159bg-slate-50 text-slate-800 // 16.7:1 ratio ✅160bg-blue-50 text-blue-900 // 14.2:1 ratio ✅161162// Dark backgrounds163bg-slate-900 text-white // 21:1 ratio ✅164bg-slate-800 text-slate-100 // 15.8:1 ratio ✅165bg-blue-900 text-blue-50 // 18.1:1 ratio ✅166167// Buttons - maintain contrast in ALL states168bg-blue-600 text-white // Primary buttons ✅169bg-slate-900 text-white // Secondary buttons ✅170hover:bg-blue-700 hover:text-white // Maintain on hover ✅171```172173### CRITICAL: Avoid These Common Accessibility Failures174```tsx175// ❌ Poor contrast combinations - AVOID THESE PATTERNS176bg-slate-400 text-white // Only 3.1:1 ratio177bg-slate-500 text-white // Only 4.6:1 ratio (use darker backgrounds)178text-slate-400 on bg-white // Common CTA text mistake179text-slate-500 on bg-slate-100 // Poor secondary button contrast180border-slate-400 text-slate-400 // Poor outline button181border-white/30 text-white // Border invisible182bg-gray-100 text-gray-500 // Very common but poor contrast183184// ✅ Better alternatives - USE THESE PATTERNS185bg-slate-600 text-white // 8.59:1 ratio - safe186bg-slate-700 text-white // 11.63:1 ratio - safer187text-slate-700 on bg-white // 10.45:1 ratio - excellent188border-slate-700 text-slate-700 // High contrast outline189bg-slate-900 text-slate-100 // 15.8:1 ratio - premium190```191192### Button Accessibility Requirements193**All buttons must maintain proper contrast in ALL states:**194```tsx195// ✅ Perfect button patterns196<Button className="bg-blue-600 hover:bg-blue-700 text-white focus:ring-4 focus:ring-blue-500/50">197<Button className="border-2 border-slate-900 text-slate-900 hover:bg-slate-900 hover:text-white">198<Button disabled className="bg-slate-300 text-slate-600 cursor-not-allowed">199200// ❌ Never use these patterns201<Button className="bg-slate-400 text-white"> // Poor contrast202<Button className="text-slate-500"> // Poor contrast203<Button className="hover:text-slate-400"> // Losing contrast on hover204```205206## JSX SYNTAX RULES207208### SVG and Data URL Encoding209When using SVG data URLs in CSS backgrounds, **ALWAYS** properly encode special characters:210211❌ **WRONG - Causes build errors**:212```tsx213<div className="bg-[url('data:image/svg+xml,%3Csvg width="60" height="60"...')]" />214```215216✅ **CORRECT - Use these safe alternatives**:217```tsx218// Option 1: Use external SVG file (recommended)219<div className="bg-[url('/pattern.svg')]" />220221// Option 2: Use CSS custom properties in index.css222<div className="bg-dot-pattern" />223224// Option 3: Use Tailwind gradient utilities225<div className="bg-gradient-radial from-blue-500/10 to-transparent" />226```227228### Safe Background Pattern Classes (Add to index.css)229```css230.bg-dot-pattern {231 background-image: radial-gradient(circle, #334155 1px, transparent 1px);232 background-size: 20px 20px;233 opacity: 0.03;234}235236.bg-grid-pattern {237 background-image:238 linear-gradient(rgba(51, 65, 85, 0.03) 1px, transparent 1px),239 linear-gradient(90deg, rgba(51, 65, 85, 0.03) 1px, transparent 1px);240 background-size: 20px 20px;241}242243.bg-neural-pattern {244 background: linear-gradient(45deg, transparent 25%, rgba(168,85,247,0.1) 50%, transparent 75%),245 linear-gradient(-45deg, transparent 25%, rgba(59,130,246,0.1) 50%, transparent 75%);246 background-size: 40px 40px;247}248```249250## PREMIUM COMPONENT PATTERNS251252### Button System253```tsx254// Primary CTA - High contrast required255<Button className="group bg-gradient-to-r from-blue-600 to-purple-600 hover:from-blue-700 hover:to-purple-700 text-white px-8 py-4 rounded-2xl font-semibold shadow-lg hover:shadow-xl transition-all duration-300 hover:scale-105 overflow-hidden">256 <span className="absolute inset-0 bg-white/20 transform scale-x-0 group-hover:scale-x-100 transition-transform duration-300 origin-left" />257 <span className="relative z-10 flex items-center gap-2">258 Get Started259 <ArrowRight className="w-5 h-5 group-hover:translate-x-1 transition-transform duration-200" />260 </span>261</Button>262263// Secondary Button - Outline with hover fill264<Button variant="outline" className="group border-2 border-slate-900 text-slate-900 hover:text-white px-8 py-4 rounded-2xl font-semibold transition-all duration-300 overflow-hidden">265 <span className="absolute inset-0 bg-slate-900 transform scale-x-0 group-hover:scale-x-100 transition-transform duration-300 origin-left" />266 <span className="relative z-10">Learn More</span>267</Button>268```269270### Premium Hero Section271```tsx272<div className="relative min-h-screen overflow-hidden bg-gradient-to-br from-slate-950 via-violet-950 to-slate-950">273 {/* Floating 3D elements */}274 <div className="absolute inset-0">275 <div className="absolute top-20 left-1/4 w-64 h-64 bg-gradient-to-br from-violet-500/20 to-purple-600/20 rounded-3xl rotate-12 animate-float backdrop-blur-sm" />276 <div className="absolute top-40 right-1/4 w-48 h-48 bg-gradient-to-br from-cyan-500/20 to-blue-600/20 rounded-3xl -rotate-12 animate-float animation-delay-1000 backdrop-blur-sm" />277 </div>278279 <div className="relative z-10 min-h-screen flex items-center justify-center px-4">280 <div className="text-center max-w-6xl mx-auto space-y-8">281 <h1 className="text-7xl lg:text-9xl font-black leading-none">282 <span className="block bg-gradient-to-r from-white via-violet-200 to-white bg-clip-text text-transparent">283 FUTURE284 </span>285 <span className="block mt-4 bg-gradient-to-r from-violet-400 via-purple-500 to-pink-500 bg-clip-text text-transparent">286 AWAITS287 </span>288 </h1>289290 <p className="text-2xl lg:text-3xl text-violet-100/90 max-w-4xl mx-auto leading-relaxed font-light">291 Experience the next evolution of digital interaction292 </p>293 </div>294 </div>295</div>296```297298### Feature Cards299```tsx300<div className="grid md:grid-cols-3 gap-8">301 {features.map((feature, index) => (302 <div303 key={index}304 className="group relative bg-white/5 backdrop-blur-lg rounded-3xl p-8 border border-white/10 hover:border-white/20 transition-all duration-500 hover:scale-105 hover:-translate-y-2"305 >306 <div className="absolute inset-0 bg-gradient-to-br from-white/10 to-transparent rounded-3xl opacity-0 group-hover:opacity-100 transition-opacity duration-500" />307 <div className="relative z-10">308 <div className="w-16 h-16 bg-gradient-to-br from-blue-500 to-purple-600 rounded-2xl flex items-center justify-center mb-8 group-hover:scale-110 transition-transform duration-300">309 <Icon className="w-8 h-8 text-white" />310 </div>311 <h3 className="text-2xl font-bold text-white mb-4">{feature.title}</h3>312 <p className="text-slate-300 leading-relaxed text-lg">{feature.description}</p>313 </div>314 </div>315 ))}316</div>317```318319### Form Design320```tsx321<div className="group relative">322 <Input323 className="w-full bg-slate-50 border-slate-200 focus:border-blue-500 focus:bg-white text-slate-900 placeholder:text-slate-500 rounded-2xl px-6 py-4 text-lg transition-all duration-300 focus:shadow-lg focus:scale-[1.02]"324 placeholder="Enter your email"325 />326 <div className="absolute inset-0 rounded-2xl bg-gradient-to-r from-blue-500/10 to-purple-500/10 opacity-0 group-focus-within:opacity-100 pointer-events-none transition-opacity duration-300" />327</div>328```329330## ANIMATION SYSTEM331332### Custom Tailwind Animations (Add to tailwind.config.ts)333```javascript334theme: {335 extend: {336 animation: {337 'float': 'float 3s ease-in-out infinite',338 'shimmer': 'shimmer 2s linear infinite',339 'fade-in': 'fadeIn 0.5s ease-out',340 'gradient-x': 'gradient-x 3s ease infinite',341 },342 keyframes: {343 float: {344 '0%, 100%': { transform: 'translateY(0px)' },345 '50%': { transform: 'translateY(-10px)' }346 },347 shimmer: {348 '0%': { backgroundPosition: '-200% 0' },349 '100%': { backgroundPosition: '200% 0' }350 },351 fadeIn: {352 '0%': { opacity: '0' },353 '100%': { opacity: '1' }354 },355 'gradient-x': {356 '0%, 100%': { backgroundSize: '200% 200%', backgroundPosition: 'left center' },357 '50%': { backgroundSize: '200% 200%', backgroundPosition: 'right center' }358 }359 }360 }361}362```363364## RESPONSIVE DESIGN365366### Mobile-First Approach367```tsx368// Progressive enhancement369<div className="370 px-4 py-8371 sm:px-6 sm:py-12372 md:px-8 md:py-16373 lg:px-12 lg:py-20374">375376// Typography scaling377<h1 className="378 text-3xl font-bold379 sm:text-4xl380 md:text-5xl381 lg:text-6xl382 leading-tight383">384```
Also in chihebnabil/lovable-boilerplate
Diff this repo’s formatsOne repository carrying more than one format is the comparison this product exists for: does anyone actually write different content in each file, or is one a copy of the other?
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| chihebnabil/lovable-boilerplate.cursor/rules/design.mdc · 63 | Cursor rules | styleuido-not | 65/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/forms.mdc · 63 | Cursor rules | setupstyledo-not | 73/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/hooks.mdc · 63 | Cursor rules | styleuido-not | 61/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/services.mdc · 63 | Cursor rules | archtypesdo-not | 73/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/typescript.mdc · 63 | Cursor rules | setupstyletypessecurity+2 | 73/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/architecture.instructions.md · 63 | Copilot instructions | stylearchtypesdatabase+2 | 69/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/development.instructions.md · 63 | Copilot instructions | setupbuildtestlint-format+7 | 88/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/hooks.instructions.md · 63 | Copilot instructions | styleui | 54/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/lib.instructions.md · 63 | Copilot instructions | archtypesdo-not | 69/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/pages.instructions.md · 63 | Copilot instructions | archuido-not | 69/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/quality.instructions.md · 63 | Copilot instructions | lint-formatdeploymentdo-not | 63/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/reusable.instructions.md · 63 | Copilot instructions | uido-notagent-behaviour | 32/100 | 3 days ago | |
| chihebnabil/lovable-boilerplateCLAUDE.md · 63 | CLAUDE.md | setupbuildtestlint-format+5 | 89/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/core.mdc · 63 | Cursor rules | buildlint-formatarchui+1 | 92/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/components.instructions.md · 63 | Copilot instructions | styleuido-not | 61/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/global.instructions.md · 63 | Copilot instructions | buildlint-formatstylearch+4 | 100/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/components.mdc · 63 | Cursor rules | stylearchuido-not | 65/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/quality.mdc · 63 | Cursor rules | buildlint-formatstyleui+3 | 88/100 | 3 days ago |
Diff against .cursor/rules/design.mdc Diff against .cursor/rules/forms.mdc Diff against .cursor/rules/hooks.mdc Diff against .cursor/rules/services.mdc Diff against .cursor/rules/typescript.mdc Diff against .github/instructions/architecture.instructions.md Diff against .github/instructions/development.instructions.md Diff against .github/instructions/hooks.instructions.md Diff against .github/instructions/lib.instructions.md Diff against .github/instructions/pages.instructions.md Diff against .github/instructions/quality.instructions.md Diff against .github/instructions/reusable.instructions.md Diff against CLAUDE.md Diff against .cursor/rules/core.mdc Diff against .github/instructions/components.instructions.md Diff against .github/instructions/global.instructions.md Diff against .cursor/rules/components.mdc Diff against .cursor/rules/quality.mdc
Similar configs
Same format, overlapping stack, ranked by quality.
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| louislam/uptime-kuma.github/copilot-instructions.md · 90k | Copilot instructions | setupbuildtestlint-format+9 | 100/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/global.instructions.md · 63 | Copilot instructions | buildlint-formatstylearch+4 | 100/100 | 3 days ago | |
| JCodesMore/ai-website-cloner-template.github/copilot-instructions.md · 31k | Copilot instructions | buildlint-formatstylearch+3 | 97/100 | 2 days ago | |
| nerolis-lab/nerolis-lab.github/copilot-instructions.md · 32 | Copilot instructions | setupbuildtestlint-format+11 | 96/100 | 3 days ago | |
| thangaram611/second-brain.github/copilot-instructions.md · 0 | Copilot instructions | setupteststylearch+4 | 96/100 | 3 days ago | |
| darkmatter/nixmac.github/copilot-instructions.md · 24 | Copilot instructions | setupbuildtestlint-format+8 | 96/100 | 3 days ago | |
| keycloak/keycloak.github/copilot-instructions.md · 36k | Copilot instructions | setupbuildtestlint-format+6 | 93/100 | 3 days ago | |
| jnPiyush/AgentX.github/instructions/typescript.instructions.md · 14 | Copilot instructions | setuptestlint-formatstyle+5 | 92/100 | 3 days ago |
