Address repo-review comments

Open
#468 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
32/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
build-system, testing, tooling

Research direction

Start by reviewing pyproject.toml and .pre-commit-config.yaml against the failed repo-review checks, then inspect whether the repository has a tests folder and task-runner configuration. Confirm the relevant pytest, mypy, Ruff, and pre-commit requirements before making changes. Done means the listed PY, PP, PC, MY, and RF checks pass.

Written by the indexing model from the issue text.

Description

General
  • Detected build backend: setuptools.build_meta
  • Detected license(s): Apache Software License
?NameDescription
❌ PY005 Has tests folder

Projects must have a folder called *test* or src/*/*test*
❌ PY007 Supports an easy task runner (nox or tox)

Projects must have a noxfile.py, tox.ini, or tool.hatch.envs/tool.spin/tool.tox in pyproject.toml to encourage new contributors.
PyProject
?NameDescription
❌ PP301 Has pytest in pyproject

Must have a [tool.pytest.ini_options] configuration section in pyproject.toml. If you must have it somewhere else (such as to support pytest<6), ignore this check.
Pre-commit
?NameDescription
❌ PC111 Uses blacken-docs

Must have https://github.com/adamchainz/blacken-docs repo in .pre-commit-config.yaml
❌ PC140 Uses mypy

Must have https://github.com/pre-commit/mirrors-mypy repo in .pre-commit-config.yaml
❌ PC160 Uses codespell

Must have https://github.com/codespell-project/codespell repo in .pre-commit-config.yaml
❌ PC180 Uses prettier

Must have https://github.com/pre-commit/mirrors-prettier repo in .pre-commit-config.yaml
❌ PC901 Custom pre-commit CI message

Should have something like this in .pre-commit-config.yaml:

ci:
  autoupdate_commit_msg: 'chore: update pre-commit hooks'
MyPy
?NameDescription
❌ MY101 MyPy strict mode

Must have strict in the mypy config. MyPy is best with strict or nearly strict configuration. If you are happy with the strictness of your settings already, ignore this check or set strict = false explicitly.

[tool.mypy]
strict = true
❌ MY102 MyPy show_error_codes deprecated

Must not have show_error_codes. Use hide_error_codes instead (since MyPy v0.990).
Ruff
?NameDescription
❌ RF101 Bugbear must be selected

Must select the flake8-bugbear B checks. Recommended:

[tool.ruff.lint]
extend-select = [
  "B",  # flake8-bugbear
]
❌ RF202 Use (new) lint config section

ignore should be set as lint.ignore instead

isort should be set as lint.isort instead

select should be set as lint.select instead
Dominant language
Python
Stars
181
Forks
49
Avg merge
43m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from xarray-contrib/cf-xarray

All issues in xarray-contrib/cf-xarray

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.