You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -182,7 +177,52 @@ We use various tools to maintain code quality:
182
177
183
178
Run `make lint-yaml`, `make lint-docker`, and `make lint-ansible` to check your code.
184
179
185
-
Thank you for contributing to docker-php-base!
180
+
Here's a list of tools we use:
181
+
182
+
### → Yaml Lint
183
+
184
+
We use [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files.
185
+
186
+
To lint yaml files run:
187
+
188
+
```bash
189
+
make lint-yaml
190
+
```
191
+
192
+
by default, [`cytopia/yamllint`](https://github.com/cytopia/docker-yamllint) Docker image will be used to run linter.
193
+
194
+
### → Action Lint
195
+
196
+
We use [`actionlint`](https://github.com/rhysd/actionlint) to enforce coding standards in GitHub Actions workflows.
197
+
198
+
To lint GitHub Actions run:
199
+
200
+
```bash
201
+
make lint-actions
202
+
```
203
+
204
+
by default, [`rhysd/actionlint`](https://hub.docker.com/r/rhysd/actionlint/tags) Docker image will be used to run linter.
205
+
206
+
### → Markdown Lint
207
+
208
+
We use [`markdownlint-cli2`](https://github.com/davidanson/markdownlint-cli2) to enforce coding standards in Markdown files.
209
+
210
+
To lint markdown files run:
211
+
212
+
```bash
213
+
make lint-md-dry
214
+
make lint-md
215
+
```
216
+
217
+
### → Ansible Lint
218
+
219
+
We use [`ansible-lint`](https://github.com/ansible/ansible-lint) to check Ansible playbooks for practices and behavior that could potentially be improved.
0 commit comments