Skip to content

docs: add Windows UTF-8 encoding note to getting started guide #4699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
escapedcat merged 1 commit into from
Apr 4, 2026
+7 −0
Merged

docs: add Windows UTF-8 encoding note to getting started guide #4699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/guides/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ Configure commitlint to use conventional config
echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js
```

> [!NOTE]
> **Windows users:** The `echo` command in PowerShell and `cmd.exe` may create the config file with a non-UTF-8 encoding (e.g. UTF-16LE or the system's default ANSI code page), which can cause commitlint to fail to read the configuration. To avoid this, create `commitlint.config.js` manually in your editor, or use PowerShell with explicit encoding:
>
> ```powershell
> "export default { extends: ['@commitlint/config-conventional'] };" | Out-File -Encoding utf8 commitlint.config.js
> ```

> [!WARNING]
> Node v24 changes the way that modules are loaded, and this includes the commitlint config file. If your project does not contain a `package.json`, commitlint may fail to load the config, resulting in a `Please add rules to your commitlint.config.js` error message. This can be fixed by doing either of the following:
>
Expand Down