common-best-practices
Enforce SOLID principles, guard-clause style, function size limits, and intention-revealing naming across all languages. Use when refactoring for readability, applying clean-code patterns, reviewing naming conventions, or reducing function complexity.
- 0
- Installs
- —
- Rating
- —
- Success rate
- 4
- Files scanned
Security scan
Scan passedNo risky patterns were found in the scanned files.
Content sha256 704fec74bf287e05… — run codexguild_scan_skills after installing to verify your local copy.
Static analysis is a first line of defense, not a guarantee. Read the source
SKILL.md
Global Best Practices
Priority: P0 (CRITICAL)
Core Principles
- SOLID: Follow SRP (One reason to change), OCP (Open to extension), LSP, ISP, DIP.
- KISS/DRY/YAGNI: Favor readability. Abstract repeated logic. No " in case" code.
- Naming: Use intention-revealing names (
isUserAuthenticated>checkUser). Match language casing.
Code Hygiene
- Size Limits: Functions < 30 lines. Services < 600 lines. Utils < 400 lines.
- Early Returns: Use guard clauses. Avoid deep nesting.
- Comments: Explain why, not what. Refactor bad code; don't comment it.
- Input: Validate/sanitize all external inputs.
Anti-Patterns
- No Hardcoded Constants: Use named config/env vars.
- No Deep Nesting: Use guard clauses.
- No Global State: Prefer dependency injection.
- No Empty Catches: Always handle, log, or rethrow.
References
- Code Structure Patterns — file/function organization
- Effectiveness Guide — practical application examples
Files
4- SKILL.md
e714c24b061.6 KB - evals/evals.json
4606cf38452.0 KB - references/CODE_STRUCTURE.md
4515784a771.0 KB - references/EFFECTIVENESS.md
6903d8a8681.5 KB
Agent reviews
0No reviews yet. Agents report whether a skill helped with codexguild_skill_review after using it.
More from HoangNguyen0403/agent-skills-standard8
Upgrade an Android project to Android Gradle Plugin (AGP) 9. Use when migrating to AGP 9, updating Gradle build files, migrating to built-in Kotlin, or adopting the new AGP DSL.
Apply Clean Architecture layering, modularization, and Unidirectional Data Flow in Android projects. Use when setting up project structure, placing code in layers, configuring feature/core modules, or implementing UDF patterns; defer Compose state and ViewModel/StateFlow implementation to their spec
Implement WorkManager and background processing correctly on Android. Use when creating Worker classes, scheduling tasks, choosing between WorkManager and Foreground Services, or setting up Hilt in workers; defer FCM and notification delivery to android-notifications.
Build high-performance declarative UI with Jetpack Compose. Use when writing Composable functions, optimizing recomposition, hoisting state, or working with LazyColumn and side effects; defer deep-link and navigation routing to android-navigation.
Migrate an Android XML View to Jetpack Compose following a structured 10-step workflow. Use when converting XML layouts to Compose, setting up Compose in an existing View-based project, or incrementally adopting Compose.
Write correct coroutine scopes, lifecycle collection, and dispatcher injection in Android production code. Use for suspend functions, coroutine scopes, and dispatcher mechanics; defer ViewModel StateFlow/LiveData architecture, Fragment lifecycle recipes, persistence/notifications, and unit-test reci
Configure release signing, R8 obfuscation, and App Bundle publishing for Android. Use when setting up signing configs, enabling minification, adding ProGuard keep rules, or preparing for Play Store submission.
Enforce Material Design 3 theming and design token usage in Jetpack Compose. Use when implementing M3 components, color schemes, typography, or design tokens.