Skip to content

Commit 4f117b0

Browse files
Fixing lint issues
1 parent 3cb90ea commit 4f117b0

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,34 +115,36 @@ repos:
115115
```
116116
117117
**Available hooks:**
118+
118119
- `sort-dictionary` - Sorts Vale dictionary files to avoid merge conflicts
119-
- `scan-secrets` - Scans for hardcoded secrets using gitleaks
120+
- `scan-secrets` - Scans for hard-coded secrets using Gitleaks
120121
- `check-file-format` - Validates EditorConfig compliance
121122

122123
**Arguments:**
124+
123125
- `scan-secrets`: `check={whole-history,last-commit,staged-changes}` (default: `staged-changes`)
124126
- `check-file-format`: `check={all,staged-changes,working-tree-changes,branch}` (default: `working-tree-changes`)
125127

126128
### GitHub Composite Actions
127129

128-
Reusable GitHub Actions can be referenced directly from service repo workflows:
130+
Reusable GitHub Actions can be referenced directly from service repository workflows:
129131

130132
```yaml
131-
# In service repo's .github/workflows/*.yaml
133+
# In service repository's .github/workflows/*.yaml
132134
jobs:
133135
scan-secrets:
134136
steps:
135137
- uses: actions/checkout@v4
136138
- uses: NHSDigital/nhs-notify-shared-modules/.github/actions/scan-secrets@v2.1.0
137139
```
138140

139-
See [.github/actions/](./.github/actions/) for available actions.
141+
See the `.github/actions/` directory for available actions.
140142

141143
### Versioning Strategy
142144

143145
- Use **semantic versioning** for releases (e.g., `v2.1.0`)
144-
- Service repos should **pin specific tags** rather than using `main`
145-
- Update service repo references after testing new shared-modules releases
146+
- Service repositories should **pin specific tags** rather than using `main`
147+
- Update service repository references after testing new shared-modules releases
146148
- Breaking changes require major version bump
147149

148150
### Testing

0 commit comments

Comments
 (0)