Skip to content

Commit b17c0df

Browse files
authored
Update contributing.md (#334)
* Update contributing.md * Update contributing.md
1 parent a2e4b49 commit b17c0df

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

contributing.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,19 @@ Tool-specific properties are contained in namespaces in the `"customizations"` p
3737

3838
You may propose adding a new namespace for a specific tool, and any properties specific to that tool.
3939

40-
### GitHub Discussions
41-
If you'd like to discuss the spec, such as asking questions, providing feedback, or engaging on how your team may use or contribute to dev containers, please check out the [GitHub Discussions](https://github.com/devcontainers/spec/discussions) in this repo. This is a great opportunity to connect with the community and maintainers of this project, without the requirement of contributing a change to the actual spec (which we see more in issues and PRs).
40+
## Formatting Guidelines
41+
42+
When contributing an official doc or referencing dev containers in your projects, please consider the following guidelines:
43+
44+
- Refer to the spec as the "Development Container Specification"
45+
- All capital letters
46+
- Singular "Container" rather than plural "Containers"
47+
- The term "dev container" shouldn't be capitalized on its own
48+
- It should only be capitalized when referring to an official tool title, like the VS Code Dev Containers extension
49+
- Signify `devcontainer.json` is a file type through backticks
50+
- Features and Templates should always be capitalized
51+
- Refer to the CLI as the "Dev Container CLI" (note the caps)
52+
- Use bolding for emphasis sprinkled throughout sections, rather than try to use it to always bold certain terms
4253

4354
## Review process
4455

@@ -48,3 +59,9 @@ We use the following [labels](https://github.com/microsoft/dev-container-spec/la
4859
- `finalization`: Proposals we intend to make part of the spec.
4960

5061
[Milestones](https://github.com/microsoft/dev-container-spec/milestones) use a "month year" pattern (i.e. January 2022). If a finalized proposal is added to a milestone, it is intended to be merged during that milestone.
62+
63+
## Community Engagement
64+
There are several additional options to engage with the dev container community, such as asking questions, providing feedback, or engaging on how your team may use or contribute to dev containers:
65+
- [GitHub Discussions](https://github.com/devcontainers/spec/discussions): This is a great opportunity to connect with the community and maintainers of this project, without the requirement of contributing a change to the actual spec (which we see more in issues and PRs)
66+
- [Community Slack channel](https://aka.ms/dev-container-community): This is a great opportunity to connect with the community and maintainers
67+
- You can always check out the issues and PRs (and contribute new ones) across the repos in the [Dev Containers GitHub org](https://github.com/devcontainers) too!

0 commit comments

Comments
 (0)