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

Add repo revew to tephi #164

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

ESadek-MO
Copy link
Contributor

@ESadek-MO ESadek-MO commented Nov 4, 2024

🚀 Pull Request

Starts #155

  • Adopt repo review, with all checks ignored for the time being

This was referenced Nov 4, 2024
@ESadek-MO
Copy link
Contributor Author

I'm happy for this to be merged in now, and then track ignores in #155

rev: 2024.08.19
hooks:
- id: sp-repo-review
additional_dependencies: ["repo-review[cli]"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
additional_dependencies: ["repo-review[cli]"]
additional_dependencies: ["repo-review[cli]"]
args: ["--show=errskip"]

Aligns with the template (which itself is based on other SciTools repos).

Comment on lines +15 to +36
[tool.repo-review]
# These are a list of the currently failing tests:
ignore = [
"PY005", # Has tests folder --
"PP003", # Does not list wheel as a build-dep --
"PP301", # Has pytest in project --
"PP304", # Sets the log level in pytest s
"PP305", # Specifies xfail_strict s
"PP306", # Specifies strict config s
"PP307", # Specifies strict markers s
"PP309", # Filter warnings specified s
"GH212", # Require GHA update grouping --
"PC110", # Uses black or ruff-format --
"PC140", # Uses a type checker --
"PC160", # Uses a spell checker --
"PC170", # Uses PyGrep hooks (only needed if rST present) --
"PC180", # Uses a markdown formatter --
"PC190", # Uses Ruff --
"PC901", # Custom pre-commit CI message --
"MY100", # Uses MyPy (pyproject config) --
"RF001", # Has Ruff config --
]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please can each of these include a URL to the documentation for this error, which is what we have done with other repos e.g.

(I think I remember specific discussions about this, although I'm a bit hazy. That would suggest it's something we care about).

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

Successfully merging this pull request may close these issues.

2 participants