-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
enhancementNew feature or requestNew feature or requesthacktoberfestFor Hacktoberfest Participants!For Hacktoberfest Participants!help wantedExtra attention is neededExtra attention is neededwindows
Description
Windows testing & support (hooks + docs + CI)
Summary
Ensure CommitLM works smoothly on Windows (PowerShell/CMD), including hook installation/execution, CRLF handling, and quick-start docs. Add a minimal Windows CI smoke test.
Motivation
Reducing setup friction in Windows increases adoption and contribution success.
Scope
- Detect Windows during
commitlm install-hookand install PowerShell/CMD-friendly hooks (shebang/exec bit considerations, CRLF-safe wrappers). - Add README “Windows setup” block (PowerShell policy note, venv activation, sample workflow).
- Add GitHub Actions job (
windows-latest) that runs a smoke test: init a temp repo, install hooks, create a dummy change, rungit commit, confirm docs file created.
Out of scope
WSL-specific optimizations.
Tasks
- Update hook installer to generate
.ps1/.cmdwrappers on Windows. - Normalize line endings and document
git config core.autocrlfrecommendations. - Add README Windows section with exact commands.
- Add
windowsjob to CI with the smoke test above.
Acceptance criteria
- Hooks install and run successfully on Win 11 + Git for Windows (CI proves it).
- README contains a concise Windows quick-start.
- No crash when default shell is PowerShell or CMD.
Test plan
commitlm init && commitlm install-hookon Windows.echo "x" > demo.txt && git add . && git commit -m "chore: test"→ docs file appears underdocs/.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requesthacktoberfestFor Hacktoberfest Participants!For Hacktoberfest Participants!help wantedExtra attention is neededExtra attention is neededwindows