Skip to content

docs: adds WSL related precisions for scripts #277

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

Open
baywet wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −0
Open

docs: adds WSL related precisions for scripts #277

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fabbe2
docs: adds information about running scripts with WSL
baywet Jan 14, 2026
3cb3ebb
docs: alternative to CRLF edits
baywet Jan 14, 2026
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
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,14 @@ A new minor version X.(Y+1).0 or major version (X+1).0.0 is started similarly:
- commit changes
2. Push branch `start-X'.Y'.0` and merge into `main` via pull request

### Publishing using WSL

If you are running those scripts using Windows Subsystems for Linux (WSL), and cloned the repository under windows, you'll need to make a few adjustments before you can run these procedures:

1. Save the scripts using LF, not CRLF to avoid parsing issues. You can use VSCode or any other editor to do that. Alternatively, you may clone the repository again from WSL to workaround the line return issue.
1. Make sure you run the npm install from WSL and not from windows.
Copy link
Contributor

@ralfhandl ralfhandl Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which is a reason to clone from WSL and avoid accessing a local repo from both operating systems. VS Code can be started with the code command from WSL.

Copy link
Member Author

@baywet baywet Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that with the local clone I've suggested in the previous step, it should help reduce the incidence of "cross platform installs" here. I think we should leave this suggestion just in case people make the same mistake though. Thoughts?

1. If you run into issues launching chrome, [review this StackOverflow answer](https://stackoverflow.com/a/78776116/3808675).

## Style guide for Overlay Specification

Some terminology and when to use it:
Expand Down