File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Spring User Framework - Developer Guide
2+
3+ ## Commands
4+ - ** Build** : ` ./gradlew build `
5+ - ** Run Tests** : ` ./gradlew test `
6+ - ** Run Single Test** : ` ./gradlew test --tests "com.digitalsanctuary.spring.user.service.UserServiceTest" `
7+ - ** Test with JDK17** : ` ./gradlew testJdk17 `
8+ - ** Test with JDK21** : ` ./gradlew testJdk21 `
9+ - ** Test All JDKs** : ` ./gradlew testAll `
10+ - ** Lint/Check** : ` ./gradlew check `
11+ - ** Publish Locally** : ` ./gradlew publishLocal `
12+
13+ ## Code Style Guidelines
14+ - ** Imports** : Organize imports alphabetically, no wildcards
15+ - ** Formatting** : Use proper indentation (4 spaces)
16+ - ** Documentation** : Use JavaDoc for all public classes and methods
17+ - ** Naming** : CamelCase for classes, lowerCamelCase for methods/variables
18+ - ** Logging** : Use SLF4J (Lombok @Slf4j ) with appropriate log levels
19+ - ** Error Handling** : Use specific exceptions, provide meaningful messages
20+ - ** Nullability** : Check for null before accessing potentially null references
21+ - ** Services** : Use @RequiredArgsConstructor with final fields for DI
You can’t perform that action at this time.
0 commit comments