Welcome to our Developer Style Guide! This document outlines best practices for coding, documentation, and formatting to ensure consistency across all projects. 🚀
Code Conventions
- Indentation: Use 4 spaces per level.
- Braces: Always place opening braces on the same line as the control statement.
- Spacing: Add a space after commas and semicolons.
Documentation Standards
- Write clear and concise comments.
- Use Markdown for documentation.
- Link to relevant resources: Developer Best Practices
Naming Conventions
- Variables:
snake_case
- Functions:
camelCase
- Constants:
UPPER_SNAKE_CASE
Formatting Tips
- Align code blocks for readability.
- Use emojis to highlight key points! 🧾
- Keep functions under 20 lines.
For more details, check out our Code Quality Guidelines. 📚