Skip to content

Commit 7faf878

Browse files
committed
fix: contributing guideline to use hatch for testing
1 parent 91781c8 commit 7faf878

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8+
### Changed:
9+
- Misc: Documentation update contributing instructions.
810

911
## [0.20.0] - 2024-08-24
1012
### Added:

docs/home/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ Run the following lines of code and ensure the <mark>unit tests pass</mark> and
7777
<mark>code coverage is 100%</mark>.
7878

7979
```console
80-
$ python -m pip install pytest pytest-cov coverage
81-
$ pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=bigtree
80+
$ python -m pip install hatch
81+
$ hatch run cov
8282
```
8383

8484
## Documentation

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ dependencies = [
6767
]
6868

6969
[tool.hatch.envs.default.scripts]
70-
cov = "no-cov && coverage report --show-missing --omit='*/workflows/*' {args} --benchmark-autosave --benchmark-histogram=.benchmarks/histogram --benchmark-json .benchmarks/output.json"
71-
cov2 = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=bigtree {args} --benchmark-autosave --benchmark-histogram=.benchmarks/histogram --benchmark-json .benchmarks/output.json"
70+
cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=bigtree {args} --benchmark-autosave --benchmark-histogram=.benchmarks/histogram --benchmark-json .benchmarks/output.json"
71+
cov2 = "no-cov && coverage report --show-missing --omit='*/workflows/*' {args} --benchmark-autosave --benchmark-histogram=.benchmarks/histogram --benchmark-json .benchmarks/output.json"
7272
no-cov = "pytest . {args}"
7373
lint = "black -l 88 ."
7474
sort = "isort --profile black ."

0 commit comments

Comments
 (0)