Clean Code

1---
2description: Guidelines for writing clean, maintainable, and human-readable code. Apply these rules when writing or reviewing code to ensure consistency and quality.
3globs: 
4---
5# Clean Code Guidelines
6 
7## Constants Over Magic Numbers
8- Replace hard-coded values with named constants
9- Use descriptive constant names that explain the value's purpose
10- Keep constants at the top of the file or in a dedicated constants file
11 
12## Meaningful Names
13- Variables, functions, and classes should reveal their purpose
14- Names should explain why something exists and how it's used
15- Avoid abbreviations unless they're universally understood
16 
17## Smart Comments
18- Don't comment on what the code does - make the code self-documenting
19- Use comments to explain why something is done a certain way
20- Document APIs, complex algorithms, and non-obvious side effects
21 
22## Single Responsibility
23- Each function should do exactly one thing
24- Functions should be small and focused
25- If a function needs a comment to explain what it does, it should be split
26 
27## DRY (Don't Repeat Yourself)
28- Extract repeated code into reusable functions
29- Share common logic through proper abstraction
30- Maintain single sources of truth
31 
32## Clean Structure
33- Keep related code together
34- Organize code in a logical hierarchy
35- Use consistent file and folder naming conventions
36 
37## Encapsulation
38- Hide implementation details
39- Expose clear interfaces
40- Move nested conditionals into well-named functions
41 
42## Code Quality Maintenance
43- Refactor continuously
44- Fix technical debt early
45- Leave code cleaner than you found it
46 
47## Testing
48- Write tests before fixing bugs
49- Keep tests readable and maintainable
50- Test edge cases and error conditions
51 
52## Version Control
53- Write clear commit messages
54- Make small, focused commits
55- Use meaningful branch names