"Code quality standards":
"Core principles":
"No unused code":
Rule: Don't write unused code
Requirement: Ensure everything written is utilized in the project
Priority: critical
"Readability first":
Rule: Prioritize readability for human understanding over execution efficiency
Priority: critical
Maintainability:
Rule: Maintain long-term maintainability over short-term optimization
Priority: high
Simplicity:
Rule: Avoid unnecessary complexity
Approach: Implement simple solutions unless complexity is truly required
Priority: high
"Clean code philosophy":
Rule: Follow Linus Torvalds' clean code principles
Guidelines[5]: Keep it simple,Make code readable like prose,Avoid premature optimization,Express intent clearly,Minimize abstraction layers
Priority: high
"Documentation standards":
"Comment purpose":
Rule: "Comments must explain 'what' (business logic/purpose) and 'why' (reasoning/decisions), not 'how'"
Priority: high
"Avoid over-commenting":
Rule: Avoid over-commenting
Rationale: Excessive comments indicate poor code quality
Priority: medium
"Function comments":
Rule: Function comments must explain purpose and reasoning
Placement: Placed at function beginnings
Priority: medium
"Self-explanatory code":
Rule: Well-written code should be self-explanatory
Method: Through meaningful names and clear structure
Priority: high
"Development process":
Description: Follow these steps in order for effective development
Priority: critical
Steps[6]: - Step: 1
Name: Understand first
Action: Use available tools to understand data structures before implementation
Importance: critical - Step: 2
Name: Design data structures
Rationale: Good data structures lead to good code
Importance: critical - Step: 3
Name: Define interfaces
Action: Specify all input/output structures before writing logic
Importance: high - Step: 4
Name: Define functions
Action: Create all function signatures before implementation
Importance: high - Step: 5
Name: Implement logic
Action: Write implementation only after structures and definitions are complete
Importance: high - Step: 6
Name: Validate code quality
Action: Always run lint and typecheck after writing code. Fix all linting errors and type errors before considering the task complete
Requirement: Zero tolerance for lint and typecheck errors
Importance: critical
"Quality guidelines":
"Avoid over-engineering":
Rule: Avoid over-engineering
Focus: Focus on minimal viable solutions meeting acceptance criteria
Priority: high
"Testing approach":
Rule: Only create automated tests if explicitly required
Priority: medium
"Feature scope":
Rule: Never add functionality 'just in case'
Requirement: Implement only what's needed now
Priority: high
"Code validation":
Rule: Always run lint and typecheck after code changes
Requirement: Must fix all linting and type checking errors before completion
Process: "Run lint command, then typecheck command. Address all errors and warnings"
Tolerance: Zero tolerance for lint or typecheck errors
Priority: critical
"Decision making framework":
Description: Apply these principles systematically for all decisions
Priority: high
Principles[8]{Step,Principle,Importance}:
1,Gather Complete Information,critical
2,Multi-Perspective Analysis,high
3,Consider All Stakeholders,high
4,Evaluate Alternatives,high
5,Assess Impact & Consequences,high
6,Apply Ethical Framework,medium
7,Take Responsibility,high
8,Learn & Adapt,high
Meta:
Purpose: "Guidelines for code quality, development process, and decision-making"
"Target audience": AI coding assistants and developers
Version: "1.0"