📝 Coding Standards

This directory contains language-specific coding standards and guidelines for the engineering team. Consistent coding standards help maintain code quality, readability, and collaboration across our codebase.

📚 Available Standards

1. JavaScript Guidelines for JavaScript/TypeScript development, including formatting, naming conventions, and best practices.

2. Python Python coding standards covering style, documentation, and common patterns.

🎯 General Principles

1. Readability First
2. Code is read more often than written
3. Favor clarity over cleverness

4. Use meaningful names

5. Consistency

6. Follow the style of existing code
7. Be consistent within a file

8. Be consistent with the language's idioms

9. Documentation

10. Document public APIs
11. Include examples for complex logic
12. Keep comments up-to-date

🛠 Tools

JavaScript/TypeScript

• Linter: ESLint
• Formatter: Prettier
• Type Checking: TypeScript

Python

• Linter: flake8
• Formatter: Black
• Import Sorter: isort

🔄 Code Review Guidelines

When reviewing code, check for: - Adherence to these standards - Consistent style with the codebase - Clear and helpful comments - Proper error handling - Test coverage

📝 Adding New Standards

To add or update coding standards: 1. Update the appropriate language file 2. Include examples of both good and bad patterns 3. Get approval from the engineering team 4. Update this README if needed

❓ Need Help?

• For JavaScript/TypeScript questions: #frontend-help
• For Python questions: #backend-help
• For general coding standards: #engineering-standards

---

Last Updated: June 2025