Skip to content

Commit

Permalink
Update user docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mnhock committed Jun 11, 2024
1 parent bd82fff commit d21e838
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/USERGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Architecture rules are defined using Taikai's fluent API, allowing developers to

#### Test Configuration

Test configuration involves specifying constraints related to testing frameworks and practices. Let's explore the rules defined in the provided source code:
Test configuration involves specifying constraints related to testing frameworks and practices.

- **JUnit 5 Configuration**: Ensure that JUnit 5 test classes and methods are not annotated with `@Disabled`.

Expand All @@ -38,9 +38,9 @@ Taikai.builder()

#### Java Configuration

Java configuration involves defining constraints related to Java language features, coding standards, and architectural patterns. Let's examine the rules defined in the provided source code:
Java configuration involves defining constraints related to Java language features, coding standards, and architectural patterns.

- **No Usage of Deprecated APIs**: Ensure that deprecated APIs are not used in the codebase.
- **No Usage of Deprecated APIs**: Ensure that deprecated APIs annotated with `Deprecated` not used in the codebase.

```java
Taikai.builder()
Expand All @@ -51,7 +51,7 @@ Taikai.builder()
.check();
```

- **Classes Should Implement `hashCode` and `equals`**: Ensure that classes override the `hashCode` and `equals` methods for proper object comparison.
- **Classes Should Implement `hashCode` and `equals`**: Ensure that classes override the `hashCode` and `equals` methods.

```java
Taikai.builder()
Expand Down Expand Up @@ -114,7 +114,7 @@ Taikai.builder()

#### Spring Configuration

Spring configuration involves defining constraints specific to Spring Framework usage. Let's incorporate the Spring-related rules defined in the provided source code:
Spring configuration involves defining constraints specific to Spring Framework usage.

- **No Autowired Fields Configuration**: Ensure that fields are not annotated with `@Autowired` and constructor injection is preferred.

Expand All @@ -127,7 +127,7 @@ Taikai.builder()
.check();
```

- **Spring Boot Configuration**: Ensure that the main application class annotated with `@SpringBootApplication` is in the default package.
- **Spring Boot Configuration**: Ensure that the main application class annotated with `@SpringBootApplication` is located in the default package.

```java
Taikai.builder()
Expand All @@ -152,7 +152,7 @@ Taikai.builder()
.check();
```

- **Controllers Configuration**: Ensure that controller classes end with "Controller" or match a specific regex pattern, are annotated with `@RestController`, do not depend on other controllers, and are package-private.
- **Controllers Configuration**: Ensure that controller classes end with "Controller" or match a specific regex pattern, are annotated with `@RestController`, do not depend on other controllers, and are package-private.

```java
Taikai.builder()
Expand Down

0 comments on commit d21e838

Please sign in to comment.