Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address repo-review comments #468

Open
dcherian opened this issue Sep 27, 2023 · 0 comments
Open

Address repo-review comments #468

dcherian opened this issue Sep 27, 2023 · 0 comments

Comments

@dcherian
Copy link
Contributor

dcherian commented Sep 27, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant