This document outlines the coding standards to be followed when contributing to our project. These standards are designed to ensure consistency, readability, and maintainability of the codebase.
Language Style
Our project primarily uses Markdown for documentation and TypeScript for the core codebase. However, contributors are welcome to use other languages and frameworks as long as they adhere to the established coding standards.
General Guidelines
- Indentation: Use 2 spaces for indentation.
- Line Length: Keep lines to a maximum of 80 characters.
- Naming Conventions:
- Use camelCase for variable and function names.
- Use PascalCase for class and module names.
- Use kebab-case for CSS class names.
- Comments: Use comments to explain the purpose of complex logic or code blocks.
Code Formatting
- Whitespace: Avoid unnecessary whitespace.
- Braces: Always use braces for if/else and switch statements, even if they have only one line.
- Curly Braces: Always use curly braces for functions, classes, and interfaces.
Testing
- Unit Tests: Write unit tests for all functions and methods.
- Integration Tests: Write integration tests to ensure that the components work together correctly.
- Continuous Integration: Use a continuous integration system to run tests automatically.
Code Review
- Pull Requests: All contributions must be submitted as pull requests.
- Code Review: Contributions will be reviewed by the maintainers to ensure they meet the coding standards.
Contributing
If you're interested in contributing to our project, please read our Contribution Guidelines.
Golden Retriever