general-best-practices

Solid

General software development best practices covering code quality, testing, security, performance, and maintainability across technology stacks

Testing & QA 121 stars 18 forks Updated 4 months ago Apache-2.0

Install

View on GitHub

Quality Score: 77/100

Stars 20%
69
Recency 20%
50
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# General Best Practices A comprehensive collection of software development best practices applicable across various technology stacks and project types. ## Code Quality ### Readability and Maintainability Write short, focused functions with a single responsibility. Use clear, descriptive names for variables, functions, and classes. Avoid deep nesting; prefer early returns and guard clauses. Keep functions and methods to a reasonable length (typically under 30 lines). ### Error Handling Always handle errors explicitly rather than silently ignoring them. Use wrapped errors for traceability and context. Provide meaningful error messages that help with debugging. Fail fast and fail loudly during development. ### Code Organization Organize code into logical modules and packages. Separate concerns: keep business logic separate from infrastructure code. Use consistent file and folder naming conventions. Follow the principle of least surprise in API design. ## Architecture ### Clean Architecture Principles Structure code into distinct layers: - **Presentation/Handlers**: Handle external requests and responses - **Application/Services**: Orchestrate business operations - **Domain**: Core business logic and entities - **Infrastructure**: External systems, databases, and frameworks ### Design Principles Prefer composition over inheritance. Program to interfaces, not implementations. Use dependency injection for testability and flexibility. Design for change: i...

Details

Author
Mindrally
Repository
Mindrally/skills
Created
4 months ago
Last Updated
4 months ago
Language
N/A
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category