Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 1.36 KB

File metadata and controls

78 lines (51 loc) · 1.36 KB

Coding Standards

Overview

[Introduction to coding standards and their importance]

General Principles

Code Quality

[General code quality principles]

Readability

[Importance of readable code]

Maintainability

[Writing maintainable code]

Language-Specific Standards

JavaScript/TypeScript

[JavaScript and TypeScript coding conventions]

Naming Conventions

[Variable, function, class naming conventions]

File Structure

[How to structure JS/TS files]

ESLint Configuration

[ESLint rules and configuration]

Python

[Python coding conventions]

PEP 8 Compliance

[Following PEP 8 standards]

Type Hints

[Using type hints]

Other Languages

[Standards for other languages used in the ecosystem]

Code Formatting

Automatic Formatters

[Prettier, Black, or other formatters]

Indentation

[Indentation rules]

Line Length

[Maximum line length]

Comments and Documentation

Inline Comments

[When and how to write inline comments]

Function Documentation

[Documenting functions and methods]

API Documentation

[Documenting APIs]

Error Handling

[Error handling best practices]

Security Considerations

[Security best practices in code]

Performance Considerations

[Performance best practices]

Version Control Practices

[Git best practices]

Code Review Checklist

[Checklist for reviewing code]