coding-guidelines

Coding Guidelines

Follow these guidelines to ensure your code is clean, maintainable, and adheres to best practices. Remember, less code is better. Lines of code = Debt.

Key Mindsets

1 Simplicity: Write simple and straightforward code. 2 Readability: Ensure your code is easy to read and understand. 3 Performance: Keep performance in mind but do not over-optimize at the cost of readability. 4 Maintainability: Write code that is easy to maintain and update. 5 Testability: Ensure your code is easy to test. 6 Reusability: Write reusable components and functions.

Code Guidelines

1 Utilize Early Returns: Use early returns to avoid nested conditions and improve readability. 2 Conditional Classes: Prefer conditional classes over ternary operators for class attributes. 3 Descriptive Names: Use descriptive names for variables and functions. Prefix event handler functions with "handle" (e.g., handleClick, handleKeyDown). 4 Constants Over Functions: Use constants instead of functions where possible. Define types if applicable. 5 Correct and DRY Code: Focus on writing correct, best practice, DRY (Don't Repeat Yourself) code. 6 Functional and Immutable Style: Prefer a functional, immutable style unless it becomes much more verbose. 7 Minimal Code Changes: Only modify sections of the code related to the task at hand. Avoid modifying unrelated pieces of code. Accomplish goals with minimal code changes. 8 Formatting: Use the same formatting as the rest of the project. Use a tab indentation level of 2. Do not end lines with a semi-colon. No trailing whitespaces.

Comments and Documentation

• Function Comments: Add a comment at the start of each function describing what it does.
• JSDoc Comments: Use JSDoc comments.

Function Ordering

• Order functions with those that are composing other functions appearing earlier in the file. For example, if you have a menu with multiple buttons, define the menu function above the buttons.