docs: add Windows UTF-8 encoding note to getting started guide#4699
Merged
escapedcat merged 1 commit intoconventional-changelog:masterfrom Apr 4, 2026
Merged
Conversation
The `echo` command on Windows (both cmd.exe and PowerShell) may create files with non-UTF-8 encoding, causing commitlint to fail reading the configuration. Added a note advising Windows users to create the config file manually or use PowerShell's Out-File with explicit UTF-8 encoding. Closes conventional-changelog#788 Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Review Summary by QodoAdd Windows UTF-8 encoding warning to getting started guide
WalkthroughsDescription• Added Windows UTF-8 encoding note to getting started guide • Warns users about echo command encoding issues on Windows • Provides PowerShell alternative with explicit UTF-8 encoding • Recommends manual file creation as workaround Diagramflowchart LR
A["Getting Started Guide"] -->|"Add NOTE block"| B["Windows UTF-8 Warning"]
B -->|"Explains problem"| C["echo creates non-UTF-8 files"]
B -->|"Provides solutions"| D["Manual creation or PowerShell Out-File"]
File Changes1. docs/guides/getting-started.md
|
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewⓘ The new review experience is currently in Beta. Learn more |
This was referenced Apr 25, 2026
This was referenced Apr 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
echomay create config files with non-UTF-8 encodingOut-File -Encoding utf8and recommends creating the file manually in an editorMotivation
On Windows,
echo "..." > file.jsin bothcmd.exeand PowerShell creates files with non-UTF-8 encoding (UTF-16LE or system ANSI code page), which causes commitlint to fail reading the configuration. This has been a known pain point since 2019.Test plan
> [!NOTE]blockCloses #788
🤖 Generated with Claude Code