Skip to content

Commit

Permalink
Update contributing.md (#385)
Browse files Browse the repository at this point in the history
small update for contributing.md to include what packages to install and
how to lint.
  • Loading branch information
H-Huang authored Jun 12, 2024
1 parent e29b6b4 commit d0b4092
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
We want to make contributing to this project as easy and transparent as
possible.

## Setup
```
pip install -r dev-requirements.txt
```

## Pull Requests
We actively welcome your pull requests.
Expand All @@ -10,7 +14,7 @@ We actively welcome your pull requests.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
5. Make sure your code lints (`pre-commit run --all-files`).
6. If you haven't already, complete the Contributor License Agreement ("CLA").

## Contributor License Agreement ("CLA")
Expand Down

0 comments on commit d0b4092

Please sign in to comment.