Address repo-review suggestions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What is your issue?
Here's the output from the Scientific Python Repo Review tool.
There's an online version here.
On mac I run
pipx run 'sp-repo-review[cli]' --format html --show err gh:pydata/xarray@main | pbcopy
A lot of these seem fairly easy to fix. I'll note that there's a large number of mypy config suggestions.
General
- Detected build backend:
setuptools.build_meta - Detected license(s): Apache Software License
| ? | Name | Description |
|---|---|---|
| ❌ | PY007 |
Supports an easy task runner (nox or tox)
Projects must have a |
PyProject
See https://github.com/pydata/xarray/issues/8239#issuecomment-1739363809
| ? | Name | Description |
|---|---|---|
| ❌ | PP305 |
Specifies xfail_strict
|
| ❌ | PP308 |
Specifies useful pytest summary
|
Pre-commit
| ? | Name | Description |
|---|---|---|
| ❌ | PC110 |
Uses black
Use |
| ❌ | PC160 |
Uses codespell
Must have |
| ❌ | PC170 |
Uses PyGrep hooks (only needed if RST present)
Must have |
| ❌ | PC180 |
Uses prettier
Must have |
| ❌ | PC191 |
Ruff show fixes if fixes enabled
If |
| ❌ | PC901 |
Custom pre-commit CI message
Should have something like this in
|
MyPy
| ? | Name | Description |
|---|---|---|
| ❌ | MY101 |
MyPy strict mode
Must have
|
| ❌ | MY103 |
MyPy warn unreachable
Must have
|
| ❌ | MY104 |
MyPy enables ignore-without-code
Must have
|
| ❌ | MY105 |
MyPy enables redundant-expr
Must have
|
| ❌ | MY106 |
MyPy enables truthy-bool
Must have
|
Ruff
| ? | Name | Description |
|---|---|---|
| ❌ | RF101 |
Bugbear must be selected
Must select the flake8-bugbear
|
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the supplied Scientific Python Repo Review command and inspect the repository configuration, especially .pre-commit-config.yaml and the PyProject settings. Check the noxfile.py or tox.ini requirement alongside the pytest, MyPy, Ruff, and pre-commit suggestions. Done means the selected suggestions are addressed and the review no longer reports those failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, testing, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100