Vibe Coding Rules Set Template Generator

Create and customize vibe coding rules set templates that can be applied to your team and projects.

Coding Rules Template Editor

# Vibe Coding Rules Set

## Code Style Rules
**Variable and Function Naming**
 - Intuitive and clear names
 - Variables: noun form, use is, has, can prefixes for state
 - Functions: start with verb, use is, has, can prefixes for boolean returns
 - Constants: UPPER_SNAKE_CASE
 - Avoid abbreviations (except widely known ones like URL, API)

**Development Rules and Code Quality**
 - One function should have only one responsibility
 - Keep functions under 15 lines (separate complex logic)
 - Prioritize pure functions
 - Nesting depth should not exceed 3 levels

**Comment Writing**
 - Explain 'why' rather than 'what' the code does
 - Add explanatory comments for complex business logic
 - Add brief descriptions for each API endpoint
 - Actively use TODO, FIXME, HACK tags

## Testing Guidelines
**Testing Priorities**
 - Core business logic - must test
 - User interactions - important flows only
 - Utility functions - complex logic only
 - UI components - focus on conditional rendering

**Testing Standards**
 - Test coverage goal: 80% or higher (core logic 100%)
 - Follow Given-When-Then pattern
 - Use mocks only for external dependencies

## Security and Error Handling
**Security Checklist**
 - Manage sensitive information with environment variables
 - Validate on both frontend and backend
 - User-friendly error messages
 - Follow basic security considerations: XSS, CSRF, SQL injection prevention

## Responsive Design and Accessibility
**Basic Accessibility Principles**
 - Use meaningful HTML semantic tags
 - Provide appropriate ARIA labels
 - Support keyboard navigation
 - Don't rely solely on color for information

## Deployment and Monitoring
**Logging and Monitoring**
 - Development: detailed logs
 - Production: errors and important events only
 - Never log user personal information

## Documentation Principles
**README Essentials**
 - Project description and purpose
 - Installation and execution instructions
 - Key feature introduction
 - API documentation (if applicable)

**Code Documentation**
 - Explanation of complex business logic
 - API interface specifications

## Refactoring Guide
**Refactoring Signals**
 - When the same code repeats 3+ times
 - When functions exceed 20 lines
 - When conditions nest 3+ levels deep
 - When variable or function names are unclear

**Refactoring Principles**
 - Gradual improvement in small units
 - Write test code first
 - Separate feature changes from refactoring
 - Sufficient communication with team members

## Git Commit Rules
**Commit Message Convention**
 - feat: add new feature
 - fix: bug fix
 - docs: documentation changes
 - style: code style changes (no functional changes)
 - refactor: code refactoring
 - test: add/modify test code
 - chore: build process or auxiliary tool changes

Vibe Coding Rules Template

Edit the template above to create coding rules that fit your team and project. You can use copy, download, and reset functions.

What is Vibe Coding?

Vibe Coding refers to coding styles and development culture that reflect the atmosphere and philosophy of a development team. It goes beyond simple syntax rules to encompass comprehensive development guidelines that incorporate the team's values and development philosophy.

Good vibe coding rules help team members write code in a consistent style, reduce code review time, and make onboarding new team members easier.

Code Quality Improvement Guide

Consistency: All team members write code in the same style to improve readability.
Clarity: Variable and function names clearly express intent to enhance code comprehension.
Simplicity: Complex logic is separated into small units to improve maintainability.
Testability: Code is written in a structure that is easy to test to ensure stability.

How to Use

Edit Template: Modify the provided basic template to suit your team's needs.
Team Discussion: Review the rules with team members and find common ground.
Save and Share: Copy the completed rules or download as a markdown file to share with your team.
Continuous Improvement: Update the rules as needed during project progress.

Benefits of Vibe Coding

Improved Development Efficiency: Reduce code review time with consistent coding styles.
Enhanced Team Collaboration: Strengthen team cohesion with shared development philosophy.
Code Quality Assurance: Reduce bugs and improve maintainability with systematic rules.
New Developer Onboarding: Help new team members adapt with clear guidelines.

Key Features

Real-time Editing: Modify and preview templates in real-time.
One-click Copy: Easily copy completed rules to clipboard.
Markdown Download: Download as .md file for saving and sharing.
Template Reset: Return to the default template at any time.
Customization: Freely modify to suit your team's characteristics.