microsoft / microsoft/TypeScript

Updating Windows contributor requirements to run Windows 10

Open
#35,991 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Discussion Infrastructure
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

We recently ran into a situation where git errored during a checkout due to a file path that was too long.

https://github.com/microsoft/TypeScript/pull/35711#issuecomment-570730960

To get around this, we can run

git config core.longpaths true

However, it seems that this option requires Windows users to run Windows 10. It doesn't affect other users.

Everyone on the core team who's on Windows is basically on the latest version, and we don't have reason to believe at the moment that this affects many external contributors. As a result, we will likely turn on the flag and adjust appropriately if this becomes an issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named. Start by locating the Windows contributor setup or requirements documentation and check how Git configuration is described. Done means the Windows 10 requirement and the core.longpaths guidance are documented accurately for contributors.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation, operating-systems
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.