Skip to content

Commit

Permalink
📖 Add some docs (#764)
Browse files Browse the repository at this point in the history
Some additional information with new location and missing info on
description field.

Signed-off-by: Juan Manuel Leflet Estrada <jleflete@redhat.com>
  • Loading branch information
jmle authored Jan 22, 2025
1 parent 77991ef commit 66002c2
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ category: mandatory (4)
* potential
* The issue should be examined during the migration process, but there is not enough detailed information to determine if the task is mandatory for the migration to succeed.
### Rule description
Each rule should have a `description` field with a short sentence, or "title", summarizing the highlighted problem.

```yaml
description: "Java class foo.Bar has been deprecated"
```

### Rule Actions

Expand Down Expand Up @@ -215,6 +221,7 @@ The java provider allows scoping the search down to certain source code location
* VARIABLE_DECLARATION
* FIELD (declaration)
* METHOD (declaration)
* CLASS (declaration)


##### Annotation inspection
Expand Down

0 comments on commit 66002c2

Please sign in to comment.