Skip to content

Commit 75c3d28

Browse files
authored
Update content-style-guide.md
1 parent c48d0ad commit 75c3d28

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

contributing/content-style-guide.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ steps:
365365
Examples:
366366
- See the code block in "[Publishing to package registries](https://docs.github.com/en/actions/guides/building-and-testing-python#publishing-to-package-registries)"
367367

368-
### Pinning version numbers to SHA
368+
#### Pinning version numbers to SHA
369369

370370
Code examples that use third-party actions must always pin to a full length commit SHA, instead of the version number or branch:
371371

@@ -383,6 +383,12 @@ steps:
383383

384384
For more information, see "[Using SHAs](https://docs.github.com/en/actions/learn-github-actions/finding-and-customizing-actions#using-shas)"
385385

386+
### GitHub Codespaces
387+
388+
Always use "GitHub Codespaces" (`{% data variables.product.prodname_github_codespaces %}`) as the product name, not just "Codespaces". This helps to avoid confusion with "codespaces" (lowercase c), which refers to instances of remote coding workspaces created with GitHub Codespaces.
389+
390+
Always use "dev container" (or its longer form "development container) and not "devcontainer" (one word), except in file/path names. Although "devcontainer" is very commonly used internally within GitHub, Microsoft have specifically asked us not to use this form in publicly visible places as the single word could be considered its own brand, which we want to avoid, and we also want to be consistent with the two-word form used in [the Visual Studio Code documentation](https://code.visualstudio.com/docs/remote/create-dev-container#_path-to-creating-a-dev-container).
391+
386392
## Punctuation
387393

388394
Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://brand.github.com/content/grammar#punctuation)” in GitHub’s Brand Guide and “[Punctuation](https://docs.microsoft.com/style-guide/punctuation)” in the Microsoft Style Guide.

0 commit comments

Comments
 (0)