1.3 KiB
1.3 KiB
Coding Principles (Guiding Principles Set by Composer)
- Simplicity First: Solutions should be the simplest approach that meets requirements. Readability > Cleverness.
- DRY (Don't Repeat Yourself): Maximize code reuse through functions, modules, and components.
- Robustness & Environment Awareness: Code must function reliably across intended environments. Configuration should be externalized.
- Focused Scope: Changes should address specific requirements. Avoid unintended side-effects.
- Consistency: Adhere to established architectural patterns and coding standards. Introduce new patterns thoughtfully and replace old ones completely.
- Modularity & Low Coupling: Design components with clear interfaces and minimal dependencies. This is critical for maintainability and scalability.
- Security by Design: Build security in from the start. Follow secure coding practices. Protect sensitive data.
- Testability: Design code to be easily testable. Aim for high test coverage for critical logic.
- Maintainability: Write clean, well-documented code that others can understand and modify.
- Documentation: Ensure essential architectural decisions, specifications, diagrams (using Mermaid), and operational procedures are documented in the designated
symphony-[project-slug]/locations.