forked from mengyxu/noob-components
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.3 KiB
1.3 KiB
Frontend Development Guidelines
Best practices for frontend development in this project.
Overview
This directory contains guidelines for frontend development. Fill in each file with your project's specific conventions.
Guidelines Index
| Guide | Description | Status |
|---|---|---|
| Directory Structure | Module organization and file layout | To fill |
| Component Guidelines | Component patterns, props, composition | To fill |
| Hook Guidelines | Custom hooks, data fetching patterns | To fill |
| State Management | Local state, global state, server state | To fill |
| Quality Guidelines | Code standards, forbidden patterns | To fill |
| Type Safety | Type patterns, validation | To fill |
How to Fill These Guidelines
For each guideline file:
- Document your project's actual conventions (not ideals)
- Include code examples from your codebase
- List forbidden patterns and why
- Add common mistakes your team has made
The goal is to help AI assistants and new team members understand how YOUR project works.
Language: All documentation should be written in English.