# dev-rules

> Manages development rules and best practices for the project. Invoke when user needs to define or update development guidelines, code generation rules, or project structure standards.

- Author: wenshu
- Repository: jasonwenshushu/FastapiAdmin
- Version: 20260207161129
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/jasonwenshushu/FastapiAdmin
- Web: https://mule.run/skillshub/@@jasonwenshushu/FastapiAdmin~dev-rules:20260207161129

---

---
name: "dev-rules"
description: "Manages development rules and best practices for the project. Invoke when user needs to define or update development guidelines, code generation rules, or project structure standards."
---

# Development Rules Manager

This skill helps define and manage development rules and best practices for the project. It provides a structured approach to maintaining consistent coding standards, project structure, and development workflows.

## When to Use

- **Define project development rules**
- **Update existing coding standards**
- **Configure code generation templates**
- **Establish component import rules**
- **Set up project structure guidelines**
- **Document development workflows**

## Key Features

### 1. Project Structure Rules

- **Backend Structure**: Organizes backend code into api, common, config, core, plugin, scripts, and utils directories
- **Frontend Structure**: Structures frontend code into api, assets, components, layouts, router, store, styles, utils, and views directories
- **Module Organization**: Separates system core modules from business application modules

### 2. Code Generation Rules

- **Template Management**: Maintains templates for backend and frontend code generation
- **Naming Conventions**: Enforces consistent naming across backend (snake_case) and frontend (camelCase/PascalCase)
- **Component Imports**: Provides correct import paths for frontend components

### 3. Development Workflows

- **Backend Development**: Step-by-step process from model definition to database migration
- **Frontend Development**: Workflow from API creation to UI implementation
- **Best Practices**: Guidelines for code quality, security, and performance

### 4. Component Import Rules

- **TableSelect**: `@/components/TableSelect/index.vue`
- **DatePicker**: `@/components/DatePicker/index.vue`
- **SingleImageUpload**: `@/components/Upload/SingleImageUpload.vue`
- **Pagination**: `@/components/Pagination/index.vue`
- **ImportModal/ExportModal**: `@/components/CURD/`

## Usage Examples

### Example 1: Update Component Import Paths

When frontend component structure changes, update the import rules in the template files to ensure code generation uses correct paths.

### Example 2: Define New Coding Standards

When introducing new technologies or patterns, update the development rules to include best practices and guidelines.

### Example 3: Configure Code Generation Templates

When adding new features to the code generator, update the template files and document the changes in the development rules.

## Maintenance

- **Regular Reviews**: Periodically review and update development rules as the project evolves
- **Team Alignment**: Ensure all team members are aware of and follow the established rules
- **Version Control**: Track changes to development rules alongside code changes

## Reference Files

- **User Rules**: `.trae-cn/user_rules.md` - Personal development rules
- **Project Rules**: `backend/.trae/rules/project_rules.md` - Project-specific rules
- **Template Files**: `backend/app/plugin/module_generator/gencode/templates/` - Code generation templates