Skip to content

Commit 2504179

Browse files
committed
improving readme files
1 parent dfe9beb commit 2504179

2 files changed

Lines changed: 6 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,15 @@ header_starts_with_type:
7272
metadata_has_detection:
7373
active: false
7474
```
75-
The rule `header_starts_with_type` is active, outputs warnings and checks if header starts with type `fix`.
76-
77-
The rule `metadata_has_detection` was deactivated.
75+
(The rule `header_starts_with_type` is active, outputs warnings and checks if header starts with type fix. The rule `metadata_has_detection` was deactivated.)
7876

7977
```
8078
git log -1 --pretty=%B | secomlint --config=config.yml
8179
```
8280

83-
## Check if your body is informative
81+
## Check if the message's body is informative enough
8482

85-
It is important that the body of security commit messages are somehow informative; secomlint checks your body for security-related keywords.
83+
It is important that the body of security commit messages are somehow informative; SECOMlint checks the message's body for security-related keywords.
8684

8785
```
8886
git log -1 --pretty=%B | secomlint --is-body-informative

secomlint/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,15 @@ header_starts_with_type:
7272
metadata_has_detection:
7373
active: false
7474
```
75-
The rule `header_starts_with_type` is active, outputs warnings and checks if header starts with type `fix`.
76-
77-
The rule `metadata_has_detection` was deactivated.
75+
(The rule `header_starts_with_type` is active, outputs warnings and checks if header starts with type fix. The rule `metadata_has_detection` was deactivated.)
7876

7977
```
8078
git log -1 --pretty=%B | secomlint --config=config.yml
8179
```
8280

83-
## Check if your body is informative
81+
## Check if the message's body is informative enough
8482

85-
It is important that the body of security commit messages are somehow informative; secomlint checks your body for security-related keywords.
83+
It is important that the body of security commit messages are somehow informative; SECOMlint checks the message's body for security-related keywords.
8684

8785
```
8886
git log -1 --pretty=%B | secomlint --is-body-informative

0 commit comments

Comments
 (0)