Skip to content

Commit

Permalink
Fix contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
rohan-agarwal-coinbase committed Sep 30, 2024
1 parent ebc9c08 commit 39689b7
Showing 1 changed file with 1 addition and 44 deletions.
45 changes: 1 addition & 44 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ To install all dependencies, run:
make install-deps
```

<<<<<<< HEAD
### Formatting

To format the code, run:
Expand All @@ -37,37 +36,13 @@ To detect all lint errors, run:
make lint
```

=======
### Linting

>>>>>>> cf3f5f1 (WIP)
To autocorrect all lint errors, run:

```bash
make lint-fix
```

<<<<<<< HEAD
### Testing
=======
To detect all lint errors, run:

```bash
make lint
```

<<<<<<< HEAD
### Testing

Install the `pytest` and `pytest-cov` packages to run tests:

```bash
pip install pytest pytest-cov
```

>>>>>>> cf3f5f1 (WIP)
=======
>>>>>>> 257ddef (Initial comments)
To run all tests, run:

```bash
Expand All @@ -76,26 +51,8 @@ make test

### Generating Documentation

<<<<<<< HEAD
<<<<<<< HEAD
To build and view the documentation locally, run:

```bash
make local-docs
```
=======
To generate documentation from the Python docstrings, run:

```bash
make docs
```

To view the documentation, run:
=======
To build and view the documentation, run:
>>>>>>> 257ddef (Initial comments)
```bash
make local-docs
```
>>>>>>> cf3f5f1 (WIP)
```

0 comments on commit 39689b7

Please sign in to comment.