Skip to content

Commit

Permalink
Update contributing to add File too long error for Windows (github#20735
Browse files Browse the repository at this point in the history
)

* Updating contributing for file too long error for windows development

* update nesting

* update to bulleting
  • Loading branch information
gracepark authored Aug 10, 2021
1 parent c921335 commit 9cc8741
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,3 +183,7 @@ This site can be developed on Windows, however a few potential gotchas need to b
1. Regular Expressions: Windows uses `\r\n` for line endings, while Unix based systems use `\n`. Therefore when working on Regular Expressions, use `\r?\n` instead of `\n` in order to support both environments. The Node.js [`os.EOL`](https://nodejs.org/api/os.html#os_os_eol) property can be used to get an OS-specific end-of-line marker.
1. Paths: Windows systems use `\` for the path separator, which would be returned by `path.join` and others. You could use `path.posix`, `path.posix.join` etc and the [slash](https://ghub.io/slash) module, if you need forward slashes - like for constructing URLs - or ensure your code works with either.
1. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write [scripts](/script) in JavaScript instead of Bash.
1. Filename too long error: There is a 260 character limit for a filename when Git is compiled with `msys`. While the suggestions below are not guaranteed to work and could possibly cause other issues, a few workarounds include:
- Shorten the path by cloning this repo directly into `C:\`
- Use a different Git client on Windows
- Update Git configuration: `git config --system core.longpaths true`

0 comments on commit 9cc8741

Please sign in to comment.