Fix check-rst-files pre-commit hook to work cross-platform
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 624
- Forks
- 256
- Avg merge
- 1d 34m
- Merged PRs (30d)
- 47
Description
Currently, the check-rst-files hook uses sh -c '...' which fails on Windows since Windows doesn't have sh available by default.
This issue causes pre-commit to fail on Windows with:
Executable sh not found
Let's modify the hook to use Python instead of shell commands, making it work consistently across all platforms.
Contributor guide
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.
Research direction
Start by locating the check-rst-files pre-commit hook and inspect how its current sh -c command is configured. Reproduce the Executable sh not found failure on Windows or an equivalent environment, then verify that the hook uses Python and runs consistently across platforms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100