Skip to content

Commit

Permalink
Update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mdapena committed Dec 15, 2023
1 parent 8bc92f4 commit 93a0de3
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ hide:
```console
source ./venv/Scripts/activate
```

3. Install development dependencies:

```console
Expand All @@ -100,16 +101,16 @@ hide:
During development, you have two options to run the test suite:
</p>

=== "Using Hatch"
=== "Manual"

```console
hatch run tests:test
pytest -v
```

=== "Manual"
=== "Using Hatch"

```console
pytest -v
hatch run tests:test
```

!!! tip "Validating New Event Emitters"
Expand All @@ -127,16 +128,16 @@ hide:
following command:
</p>

=== "Using Hatch"
=== "Manual"

```console
hatch run tests:typing
mypy
```

=== "Manual"
=== "Using Hatch"

```console
mypy
hatch run tests:typing
```

### Code Coverage
Expand All @@ -145,16 +146,16 @@ hide:
To check the code [coverage](https://coverage.readthedocs.io/en/7.3.3/) of your changes, run the following command:
</p>

=== "Using Hatch"
=== "Manual"

```console
hatch run tests:cov
coverage run -m pytest -v
```

=== "Manual"
=== "Using Hatch"

```console
coverage run -m pytest -v
hatch run tests:cov
```

## Pyventus Documentation
Expand Down

0 comments on commit 93a0de3

Please sign in to comment.