Skip to content

Commit

Permalink
Update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
aazuspan committed Jul 15, 2023
1 parent 757e24d commit 2fc5ce5
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
# Contributing to eeprepr

Contributions are always welcome! Bugs and feature requests can be opened in the [Issues](https://github.com/aazuspan/eerepr/issues). Questions and comments can be posted in the [Discussions](https://github.com/aazuspan/eerepr/discussions). To contribute code, please open an issue to discuss implementation, then follow the guide below to get started!

## Setup

`eeprepr` uses [Hatch](https://hatch.pypa.io/latest/) for package and environment management.
`eeprepr` uses [Hatch](https://hatch.pypa.io/latest/) for package and environment management. To set up a development environment, first fork and clone `eerepr`, then install `hatch` in your environment.

```bash
pip install hatch
```

This will install all required dependencies for development. You can enter the environment using:

```bash
hatch shell
```

and exit by typing `quit` or `CTRL + D`.

## Pre-commit Hooks

Expand Down Expand Up @@ -36,7 +50,7 @@ To measure test coverage, run:
hatch run test:cov
```

Additional arguments can be passed to `pytest` after the scrirpt name, e.g.:
Additional arguments can be passed to `pytest` after the script name, e.g.:

```bash
hatch run test:all -k feature
Expand Down

0 comments on commit 2fc5ce5

Please sign in to comment.