- name
- top1-design-conventions
- description
- Development conventions and patterns for top1-design. TypeScript project with conventional commits.
# Top1 Design Conventions
> Generated from [cubxxw/top1-design](https://github.com/cubxxw/top1-design) on 2026-08-05
## Overview
This skill teaches Claude the development patterns and conventions used in top1-design.
## Tech Stack
- **Primary Language**: TypeScript
- **Architecture**: hybrid module organization
- **Test Location**: separate
## When to Use This Skill
Activate this skill when:
- Making changes to this repository
- Adding new features following established patterns
- Writing tests that match project conventions
- Creating commits with proper message format
## Commit Conventions
Follow these commit message conventions based on 1 analyzed commits.
### Commit Style: Conventional Commits
### Prefixes Used
- `docs`
### Message Guidelines
- Average message length: ~34 characters
- Keep first line concise and descriptive
- Use imperative mood ("Add feature" not "Added feature")
*Commit message example*
```text
docs: make TOP1 DESIGN agent-first
```
## Architecture
### Project Structure: Single Package
This project uses **hybrid** module organization.
### Guidelines
- This project uses a hybrid organization
- Follow existing patterns when adding new code
## Code Style
### Language: TypeScript
### Naming Conventions
| Element | Convention |
|---------|------------|
| Files | kebab-case |
| Functions | camelCase |
| Classes | PascalCase |
| Constants | SCREAMING_SNAKE_CASE |
### Import Style: Relative Imports
### Export Style: Named Exports
*Preferred import style*
```typescript
// Use relative imports
import { Button } from '../components/Button'
import { useAuth } from './hooks/useAuth'
```
*Preferred export style*
```typescript
// Use named exports
export function calculateTotal() { ... }
export const TAX_RATE = 0.1
export interface Order { ... }
```
## Best Practices
Based on analysis of the codebase, follow these practices:
### Do
- Use conventional commit format (feat:, fix:, etc.)
- Use kebab-case for file names
- Prefer named exports
### Don't
- Don't write vague commit messages
- Don't deviate from established patterns without discussion
---
*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.*
GitHubで見る