-
Use consistent indentation throughout the codebase (e.g. 2 spaces or 4 spaces).
-
Use a consistent line length limit (e.g. 80 or 120 characters per line).
-
Use a consistent style for braces and parentheses placement (e.g. same line or new line).
-
Use clear and descriptive variable names.
-
Use comments to explain complex or non-obvious parts of the code.
-
Use consistent naming conventions for classes, functions, variables, and other identifiers.
-
Use descriptive and meaningful names that accurately reflect the purpose of the identifier.
-
Use camelCase for variable and function names, and PascalCase for class names.
-
Document all public interfaces with clear and concise descriptions.
-
Use consistent formatting for documentation (e.g. Markdown).
-
Include examples and code snippets in documentation as appropriate.
-
Use a consistent Git branching model (e.g. Gitflow or GitHub Flow).
-
Use descriptive commit messages that accurately describe the changes made.
-
Use pull requests and code reviews to ensure code quality and consistency.