회원가입
This commit is contained in:
32
doc-rule.md
Normal file
32
doc-rule.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Antigravity Rules
|
||||
|
||||
This document defines the coding and behavior rules for the Antigravity agent.
|
||||
|
||||
## General Rules
|
||||
|
||||
- **Language**: All output, explanations, and commit messages MUST be in **Korean (한국어)**.
|
||||
- **Tone**: Professional, helpful, and concise.
|
||||
|
||||
## Documentation Rules
|
||||
|
||||
### JSX Comments
|
||||
|
||||
- Mandatory use of section comments in JSX to delineate logical blocks.
|
||||
- Format: `{/* ========== SECTION NAME ========== */}`
|
||||
|
||||
### JSDoc Tags
|
||||
|
||||
- **@see**: Mandatory for function/component documentation. Must include calling file, function/event name, and purpose.
|
||||
- **@author**: Mandatory file-level tag. Use `@author jihoon87.lee`.
|
||||
|
||||
### Inline Comments
|
||||
|
||||
- High density of inline comments required for:
|
||||
- State definitions
|
||||
- Event handlers
|
||||
- Complex logic in JSX
|
||||
- Balance conciseness with clarity.
|
||||
|
||||
## Code Style
|
||||
|
||||
- Follow Project-specific linting and formatting rules.
|
||||
Reference in New Issue
Block a user