Skip to main content

Coding Standards & Conventions

Overview​

This document outlines the coding standards and conventions to be followed in the Learnille project.

General Guidelines​

  • Use consistent naming conventions
  • Follow language-specific best practices
  • Maintain code readability and maintainability

Language-Specific Standards​

TypeScript/JavaScript​

  • Use camelCase for variables and functions
  • Use PascalCase for classes and interfaces
  • Use UPPER_CASE for constants

Python​

  • Follow PEP 8 style guide
  • Use snake_case for variables and functions
  • Use PascalCase for classes

Code Review Process​

  • All code changes must go through code review
  • Ensure tests are included for new features
  • Check for security vulnerabilities

Tools and Linters​

  • Use ESLint for JavaScript/TypeScript
  • Use Prettier for code formatting
  • Configure IDE settings for consistency