jaraco / jaraco/skeleton

Apply Scientific Python repo-review suggestions

Open
#112 14 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
150
Forks
38
Avg merge
1m
Merged PRs (30d)
1

Description

Apply those rules that make sense:
https://learn.scientific-python.org/development/guides/repo-review/?repo=jaraco%2Fskeleton&branch=main

Suggestions:

**[`GH102`](https://learn.scientific-python.org/development/guides/gha-basic#GH102): Auto-cancel on repeated PRs**
At least one workflow should auto-cancel.
```yaml
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
```

**[PC100](https://learn.scientific-python.org/development/guides/style#PC100): Has pre-commit-hooks**
Must have `https://github.com/pre-commit/pre-commit-hooks` repo in `.pre-commit-config.yaml`

**[PC901](https://learn.scientific-python.org/development/guides/style#PC901): Custom pre-commit CI message**
Should have something like this in .pre-commit-config.yaml:
```yaml
ci:
autoupdate_commit_msg: 'chore: update pre-commit hooks'
```

**[RF101](https://learn.scientific-python.org/development/guides/style#RF101): Bugbear must be selected**
Must select the flake8-bugbear B checks. Recommended:
```yaml
[tool.ruff.lint]
extend-select = [
"B", # flake8-bugbear
]
```

**[RF102](https://learn.scientific-python.org/development/guides/style#RF102): isort must be selected**
Must select the isort I checks. Recommended:
```yaml
[tool.ruff.lint]
extend-select = [
"I", # isort
]
```

**[RF103](https://learn.scientific-python.org/development/guides/style#RF103): pyupgrade must be selected**
Must select the pyupgrade UP checks. Recommended:
```yaml
[tool.ruff.lint]
extend-select = [
"UP", # pyupgrade
]
```

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

Tech stack
python
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.