mirror of
https://github.com/jhd3197/ServerKit.git
synced 2026-10-29 16:17:25 +09:00
Juan Denis
97a111feb7
Add initial project files for a modern React dashboard template using Vite. Includes documentation, configuration, and core frontend source files with sidebar layout, routing, and sample dashboard page.
50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
# Claude Style Guide
|
|
|
|
## Purpose
|
|
Make Claude behave like a long-term contributor who already knows your preferences.
|
|
|
|
## Scope
|
|
Claude only. Style, structure, and expectations.
|
|
|
|
## How You Structure Code
|
|
- Use functional components with React hooks
|
|
- Separate logic into custom hooks when reusable
|
|
- Keep components small and focused
|
|
- Organize files in src/ with clear subdirectories (components/, layouts/, pages/)
|
|
|
|
## Naming Conventions
|
|
- PascalCase for component names (e.g., Sidebar.jsx)
|
|
- camelCase for variables, functions, and files (e.g., main.jsx)
|
|
- Descriptive names, avoid abbreviations
|
|
|
|
## Acceptable Abstractions
|
|
- Custom hooks for shared logic
|
|
- Context API for simple global state
|
|
- Utility functions in separate files
|
|
- Layout components for consistent structure
|
|
|
|
## What You Dislike
|
|
- Magic numbers or unexplained constants
|
|
- Over-engineering simple features
|
|
- Silent refactors without clear reasoning
|
|
- Deep nesting of components
|
|
|
|
## How You Want Diffs Scoped
|
|
- One logical change per commit
|
|
- Keep diffs minimal and focused
|
|
- Explain changes in commit messages
|
|
|
|
## How JSON Should be Shaped
|
|
- Use flat structures where possible
|
|
- Consistent key naming (camelCase)
|
|
- Avoid deeply nested objects
|
|
|
|
## What "Done" Means to You
|
|
- Code compiles and runs without errors
|
|
- Passes linting rules
|
|
- Implements the requested feature correctly
|
|
- Includes basic tests if applicable
|
|
- Documentation updated if needed
|
|
|
|
## Outcome
|
|
Claude outputs code that matches your thinking and style consistently. |