Skip to content

Commit

Permalink
Update CONTRIBUTING.md to include Git Hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
pengqun committed Feb 28, 2024
1 parent c5d992f commit 11152a8
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Contribution Guidelines

## Prerequisites

1. Install pre-commit, for example (using `pip`):

```bash
pip install pre-commit
```

For more information, see [pre-commit installation](<https://pre-commit.com/#installation>

2. Install the git hook scripts:

```bash
pre-commit install
```

Now `pre-commit` will run automatically on `git commit`, using configuration in `.pre-commit-config.yaml`!

## Adding a new item

- Try to fit your item into an existing sections. Open a suggestion to start as discussion about any new sections.
Expand Down

0 comments on commit 11152a8

Please sign in to comment.