Skip to content

Commit fc376b2

Browse files
committed
Add instructions to run Codacy analysis locally
Refs #39
1 parent 79ae749 commit fc376b2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,19 @@ and can be used as:
7474
mdl your_markdown_filename
7575
```
7676

77+
We use [Codacy](https://app.codacy.com/gh/ESMValGroup/tutorial) as an automated code analysis services. To run the analyis [locally](https://github.com/codacy/codacy-analysis-cli) on Markdown files with Docker use
78+
79+
```bash
80+
docker run \
81+
--rm=true \
82+
--env CODACY_CODE=${PWD} \
83+
--volume /var/run/docker.sock:/var/run/docker.sock \
84+
--volume ${PWD}:${PWD} \
85+
--volume /tmp:/tmp \
86+
codacy/codacy-analysis-cli \
87+
analyse --tool remark-int
88+
```
89+
7790
### Previewing your changes locally
7891

7992
If you are making a new episode or contributing to existing ones,

0 commit comments

Comments
 (0)