Skip to content

Commit

Permalink
Merge pull request #288 from kayjan/fix/contributing-guideline
Browse files Browse the repository at this point in the history
Fix contributing guideline
  • Loading branch information
kayjan authored Aug 23, 2024
2 parents 91781c8 + 2c20fe4 commit 79d8ce7
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Changed:
- Misc: Documentation update contributing instructions.

## [0.20.0] - 2024-08-24
### Added:
Expand Down
2 changes: 1 addition & 1 deletion docs/home/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Run the following lines of code and ensure the <mark>unit tests pass</mark> and
<mark>code coverage is 100%</mark>.

```console
$ python -m pip install pytest pytest-cov coverage
$ python -m pip install pytest pytest-benchmark pytest-cov coverage
$ pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=bigtree
```

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ dependencies = [
]

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

0 comments on commit 79d8ce7

Please sign in to comment.