-
Notifications
You must be signed in to change notification settings - Fork 0
Name Conventions
[prefix]/[issue-number]-[hyphen-separated-name]
Quick Reference:
| Type | Naming Convention |
|---|---|
| Component | CapWords |
| Interface / Type | CapWords |
| Function / Variable | camelCase |
| Constant | SCREAMING_SNAKE_CASE |
| File | kebab-case |
| Hook | camelCase with use prefix |
| Props Interface | CapWords with Props suffix |
Follow PEP 8 naming conventions: PEP 8 – Style Guide for Python Code
Follow Google Python Style Guide for docstrings: Google Python Style Guide – Docstrings
Quick Reference:
| Type | Naming Convention |
|---|---|
| Class | CapWords |
| Type Variables | CapWords |
| Function / Method | snake_case |
| Variable | snake_case |
| Constant | ALL_CAPS |
| File / Module | snake_case |
| Package / Folder | lowercase |
See the specific page for API Design Guidelines.
Follow PEP 8 naming conventions: PEP 8 – Style Guide for Python Code
Follow Google Python Style Guide for docstrings: Google Python Style Guide – Docstrings
Quick Reference:
| Type | Naming Convention |
|---|---|
| Class | CapWords |
| Type Variables | CapWords |
| Function / Method | snake_case |
| Variable | snake_case |
| Constant | ALL_CAPS |
| File / Module | snake_case |
| Package / Folder | lowercase |
Simulation Meeting Minutes
Frontend Meeting Minutes
Backend Meeting Minutes
Risks
User Consent and End-User License Agreement
Legal and Ethical Issues
Economic
Budget
Personas
Diversity Statement
Overall Architecture and Class Diagrams
Infrastructure and Tools
Name Conventions
Testing Plan and Continuous Integration
Security
Performance
Deployment Plan and Infrastructure
Missing Knowledge and Independent Learning
Glossary
Mockups
UI Evolution
Logging
Metrics
VeloSim Observability & Performance Insights
User Manual
Usability Tests