Skip to content

Commit 81dac24

Browse files
nh13clintval
andauthored
Apply suggestions from code review
Co-authored-by: Clint Valentine <[email protected]>
1 parent 6c1feef commit 81dac24

File tree

3 files changed

+7
-64
lines changed

3 files changed

+7
-64
lines changed

.github/workflows/publish_fgpyo.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: publish fgpyo
22

33
on:
44
push:
5-
tags: '\d+.\d+.\d+'
5+
tags: '[0-9]+.[0-9]+.[0-9]+'
66

77
env:
88
POETRY_VERSION: 1.8.2

CONTRIBUTING.md

+6-61
Original file line numberDiff line numberDiff line change
@@ -17,35 +17,35 @@ poetry install --all-extras
1717

1818
[rtd-link]: http://fgpyo.readthedocs.org/en/stable
1919
[poetry-link]: https://github.com/python-poetry/poetry
20-
[conda-link]: https://docs.conda.io/en/latest/miniconda.html
20+
[conda-link]: https://github.com/mamba-org/mamba
2121

2222
## Primary Development Commands
2323

2424
To check and resolve linting issues in the codebase, run:
2525

2626
```console
27-
poetry run ruff check --fix
27+
poetry run ruff check --fix fgpyo tests
2828
```
2929

3030
To check and resolve formatting issues in the codebase, run:
3131

3232
```console
33-
poetry run ruff format
33+
poetry run ruff format fgpyo tests
3434
```
3535

3636
To check the unit tests in the codebase, run:
3737

3838
```console
39-
poetry run pytest
39+
poetry run pytest --cov=fgpyo --cov-report=html --cov-branch
4040
```
4141

4242
To check the typing in the codebase, run:
4343

4444
```console
45-
poetry run mypy
45+
poetry run mypy fgpyo tests
4646
```
4747

48-
To generate a code coverage report after testing locally, run:
48+
To re-generate a code coverage report after testing locally, run:
4949

5050
```console
5151
poetry run coverage html
@@ -57,61 +57,6 @@ To check the lock file is up to date:
5757
poetry check --lock
5858
```
5959

60-
## Shortcut Task Commands
61-
62-
To be able to run shortcut task commands, first install the Poetry plugin [`poethepoet`](https://poethepoet.natn.io/index.html):
63-
64-
```console
65-
poetry self add 'poethepoet[poetry_plugin]'
66-
```
67-
68-
> NOTE:
69-
> Upon the release of Poetry [v2.0.0](https://github.com/orgs/python-poetry/discussions/9793#discussioncomment-11043205), Poetry will automatically support bootstrap installation of [project-specific plugins](https://github.com/python-poetry/poetry/pull/9547) and installation of the task runner will become automatic for this project.
70-
> The `pyproject.toml` syntax will be:
71-
>
72-
> ```toml
73-
> [tool.poetry]
74-
> requires-poetry = ">=2.0"
75-
>
76-
> [tool.poetry.requires-plugins]
77-
> poethepoet = ">=0.29"
78-
> ```
79-
80-
###### For Running Individual Checks
81-
82-
```console
83-
poetry task check-lock
84-
poetry task check-format
85-
poetry task check-lint
86-
poetry task check-tests
87-
poetry task check-typing
88-
```
89-
90-
###### For Running All Checks
91-
92-
```console
93-
poetry task check-all
94-
```
95-
96-
###### For Running Individual Fixes
97-
98-
```console
99-
poetry task fix-format
100-
poetry task fix-lint
101-
```
102-
103-
###### For Running All Fixes
104-
105-
```console
106-
poetry task fix-all
107-
```
108-
109-
###### For Running All Fixes and Checks
110-
111-
```console
112-
poetry task fix-and-check-all
113-
```
114-
11560

11661
## Building the Documentation
11762

README.md

-2
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ Quality of life improvements for Bioinformatics in Python.
5353
See documentation on [fgpyo.readthedocs.org](http://fgpyo.readthedocs.org/en/stable).
5454

5555

56-
# Getting Setup
57-
5856
## Development and Testing
5957

6058
See the [developer's instructions](CONTRIBUTING.md) for more information.

0 commit comments

Comments
 (0)