Skip to content

Commit

Permalink
Added pre-commit install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
KillianLucas authored Nov 1, 2023
1 parent 728492a commit ed91fc5
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,30 @@ We welcome code contributions through pull requests. Here are some guidelines:

- Once approved, your code will be merged - thank you for improving Open Interpreter!

### Code Formatting and Linting

Our project uses `black` for code formatting and `isort` for import sorting. To ensure consistency across contributions, please adhere to the following guidelines:

1. **Install Pre-commit Hooks**:

If you want to automatically format your code every time you make a commit, install the pre-commit hooks.

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

After installing, the hooks will automatically check and format your code every time you commit.

2. **Manual Formatting**:

If you choose not to use the pre-commit hooks, you can manually format your code using:

```bash
black .
isort .
```

## Running Your Local Fork

Once you've forked the code and created a new branch for your work, you can run the fork in CLI mode by following these steps:
Expand Down

0 comments on commit ed91fc5

Please sign in to comment.