Skip to content

Commit

Permalink
Fix #43, add linting process to CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
mschwager committed Jan 16, 2024
1 parent 92e7cb4 commit c7c21b7
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,19 @@ Then [install semgrep CLI](https://semgrep.dev/docs/getting-started/), and you a

### Linting

Currenty we don't use any linting tools. In the future we plan to use `yamlfmt`.
First, [install `prettier`](https://prettier.io/docs/en/install), or [use `brew`](https://formulae.brew.sh/formula/prettier) to do so.

Use the following command to check rule files for formatting errors:

```bash
prettier --check '**/*.{yaml,yml}'
```

Any issues can be automatically fixed with the following command:

```bash
prettier --write '**/*.{yaml,yml}'
```

### Testing

Expand Down

0 comments on commit c7c21b7

Please sign in to comment.