diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b3bde698dd15..7ac373ffc92f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -83,8 +83,8 @@ For complete style guidance, see our [style guide](https://docs.github.com/en/co **Make changes in a codespace:** See "[Working on GitHub Docs in a codespace](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace)" for documentation-specific setup. **Make changes locally:** -1. Fork the repository (see [official forking guide](https://docs.github.com/en/contributing)) -2. Install Node.js at the version specified in `package.json` (see [development guide](../contributing/development.md)) +1. Fork the repository (see an [official forking guide](https://docs.github.com/en/contributing)) +2. Install Node.js at the version specified in `package.json` (see a [development guide](../contributing/development.md)) 3. Create a working branch and start with your changes ### Commit your update @@ -99,7 +99,7 @@ Use our "[Self review checklist](https://docs.github.com/en/contributing/collabo **Repository-specific notes:** - Fill the "Ready for review" template -- [Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if applicable +- [Link PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if applicable - Enable [maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) A Technical Content team member will review following our [standard review process](https://docs.github.com/en/contributing). @@ -114,11 +114,11 @@ Continue contributing using our [types of contributions guide](/contributing/typ ## Windows -This site can be developed on Windows, however a few potential gotchas need to be kept in mind: +This site can be developed on Windows; however, a few potential gotchas need to be kept in mind: 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. -2. 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. +2. 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. 3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write new scripts in TypeScript rather than Bash. -4. 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 cause other issues, a few workarounds include: +4. 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 cause other issues, a few workarounds include: - Update Git configuration: `git config --system core.longpaths true` - Consider using a different Git client on Windows