Apply Scientific Python repo-review suggestions
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
Research direction
Review the linked Scientific Python repo-review results, then inspect the GitHub workflow files, .pre-commit-config.yaml, and the repository's Ruff configuration. Apply the listed GH102, PC100, PC901, RF101, RF102, and RF103 recommendations where compatible, and verify the workflows and configured checks pass.
Written by the indexing model from the issue text.
Description
Apply those rules that make sense:
https://learn.scientific-python.org/development/guides/repo-review/?repo=jaraco%2Fskeleton&branch=main
Suggestions:
GH102: Auto-cancel on repeated PRs
At least one workflow should auto-cancel.
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
PC100: Has pre-commit-hooks
Must have https://github.com/pre-commit/pre-commit-hooks 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'
RF101: Bugbear must be selected
Must select the flake8-bugbear B checks. Recommended:
[tool.ruff.lint]
extend-select = [
"B", # flake8-bugbear
]
RF102: isort must be selected
Must select the isort I checks. Recommended:
[tool.ruff.lint]
extend-select = [
"I", # isort
]
RF103: pyupgrade must be selected
Must select the pyupgrade UP checks. Recommended:
[tool.ruff.lint]
extend-select = [
"UP", # pyupgrade
]
- Dominant language
- No language data
- Stars
- 152
- Forks
- 38
- Avg merge
- 6h 27m
- Merged PRs (30d)
- 4
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from jaraco/skeleton
-
Difficulty 1/5 Under an hour Newbie friendliness 91/100
-
Difficulty 3/5 1-2 days Newbie friendliness 67/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
ci cloudflare-workers consistency d1 dependencies difficulty: easy documentation dx enhancement github-actions good first issue help wanted javascript maintenance priority: P3 tests
Difficulty 1/5 Under an hour Newbie friendliness 86/100
-
enhancement
Difficulty 2/5 Half a day Newbie friendliness 66/100
nyaomaru/changelog-bot#364 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
HyeokjaeChoi/vaultme#585 ·
Maintainers usually reply within 1 day
-
infra nível 2 · médio pronta
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
starkjr-ifpr/ifplay#31 ·
-
area:ci bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
catincloud-labs/dagster-dex#206 · 1 comment ·
Maintainers usually reply within 1 day