Skip to content

Commit

Permalink
[doc] update the contributing guide
Browse files Browse the repository at this point in the history
add instructions for code linting with  pre-commit
  • Loading branch information
Seburan committed Dec 6, 2023
1 parent 8f60417 commit ba8deb5
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,28 @@ do it again.

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.

## Code linting

We use a pre-commit hook to clean/format code before submitting a change. This allows for a cleaner code base. pre-commit will fetch and trigger the
_prettier_ and _markdown_ link tools and run it through your staged files.

Install pre-commit on your cloud top

```shell
sudo apt install pre-commit
```

Then install the git hook :

```shell
pre-commit install
```

you can also run pre-commit on all the files manually before committing your changes :

```shell
pre-commit run --all-files
```

more information about pre-commit : <https://pre-commit.com/>

0 comments on commit ba8deb5

Please sign in to comment.