jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update content-style-guide.md

Browse Source
This commit is contained in:
hubwriter
2022-03-24 15:37:52 +00:00
committed by GitHub
parent c48d0ad2c4
commit 75c3d285ba
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
contributing/content-style-guide.md
View File

@@ -365,7 +365,7 @@ steps:
Examples: Examples:
- See the code block in "[Publishing to package registries](https://docs.github.com/en/actions/guides/building-and-testing-python#publishing-to-package-registries)" - See the code block in "[Publishing to package registries](https://docs.github.com/en/actions/guides/building-and-testing-python#publishing-to-package-registries)"
### Pinning version numbers to SHA #### Pinning version numbers to SHA
Code examples that use third-party actions must always pin to a full length commit SHA, instead of the version number or branch: Code examples that use third-party actions must always pin to a full length commit SHA, instead of the version number or branch:
@@ -383,6 +383,12 @@ steps:
For more information, see "[Using SHAs](https://docs.github.com/en/actions/learn-github-actions/finding-and-customizing-actions#using-shas)" For more information, see "[Using SHAs](https://docs.github.com/en/actions/learn-github-actions/finding-and-customizing-actions#using-shas)"
### GitHub Codespaces
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.
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).
## Punctuation ## Punctuation
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. 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.