From dcd01633ba1b8d4731ee4728b18e2c1e1b4f2beb Mon Sep 17 00:00:00 2001 From: Brigit Murtaugh Date: Mon, 6 Nov 2023 14:49:38 -0800 Subject: [PATCH 1/4] Update contributing.md --- contributing.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index 90d7ccba..69143286 100644 --- a/contributing.md +++ b/contributing.md @@ -38,7 +38,21 @@ Tool-specific properties are contained in namespaces in the `"customizations"` p You may propose adding a new namespace for a specific tool, and any properties specific to that tool. ### GitHub Discussions -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). +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 issues across the repos in the [Dev Containers GitHub org](https://github.com/devcontainers/devcontainers.github.io/edit/gh-pages/contributing.md) and consider joining our [community Slack channel](https://aka.ms/dev-container-community). This is a great opportunity to connect with the community and maintainers of this project. + +## Formatting Guidelines + +When contributing an official doc or referencing dev containers in your projects, please consider the following guidelines: + +- Refer to the spec as the "Development Container Specification" + - All capital letters + - Singular "Container" rather than plural "Containers" +- The term "dev container" shouldn't be capitalized on its own + - It should only be capitalized when referring to an official tool title, like the VS Code Dev Containers extension +- Signify `devcontainer.json` is a file type through backticks +- Features and Templates should always be capitalized +- Refer to the CLI as the "Dev Container CLI" (note the caps) +- Use bolding for emphasis sprinkled throughout sections, rather than try to use it to always bold certain terms ## Review process From a48f326e058d93d5f56d1292bab50a7b6924ff5d Mon Sep 17 00:00:00 2001 From: Brigit Murtaugh Date: Mon, 6 Nov 2023 14:53:46 -0800 Subject: [PATCH 2/4] Update contributing.md --- contributing.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/contributing.md b/contributing.md index 69143286..72dbbdca 100644 --- a/contributing.md +++ b/contributing.md @@ -37,8 +37,11 @@ Tool-specific properties are contained in namespaces in the `"customizations"` p You may propose adding a new namespace for a specific tool, and any properties specific to that tool. -### GitHub Discussions -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 issues across the repos in the [Dev Containers GitHub org](https://github.com/devcontainers/devcontainers.github.io/edit/gh-pages/contributing.md) and consider joining our [community Slack channel](https://aka.ms/dev-container-community). This is a great opportunity to connect with the community and maintainers of this project. +### Community Engagement +There are several options to engage with the dev container community, such as asking questions, opening proposals, providing feedback, or engaging on how your team may use or contribute to dev containers: +- [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) +- Check out the issues and PRs across the repos in the [Dev Containers GitHub org](https://github.com/devcontainers/devcontainers.github.io/edit/gh-pages/contributing.md) +- [Community Slack channel](https://aka.ms/dev-container-community): This is a great opportunity to connect with the community and maintainers ## Formatting Guidelines From 3776a443043dcd50c753988618ae2ce76b0e6b39 Mon Sep 17 00:00:00 2001 From: Brigit Murtaugh Date: Mon, 6 Nov 2023 14:55:51 -0800 Subject: [PATCH 3/4] Update contributing.md --- contributing.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/contributing.md b/contributing.md index 72dbbdca..543d07ee 100644 --- a/contributing.md +++ b/contributing.md @@ -37,12 +37,6 @@ Tool-specific properties are contained in namespaces in the `"customizations"` p You may propose adding a new namespace for a specific tool, and any properties specific to that tool. -### Community Engagement -There are several options to engage with the dev container community, such as asking questions, opening proposals, providing feedback, or engaging on how your team may use or contribute to dev containers: -- [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) -- Check out the issues and PRs across the repos in the [Dev Containers GitHub org](https://github.com/devcontainers/devcontainers.github.io/edit/gh-pages/contributing.md) -- [Community Slack channel](https://aka.ms/dev-container-community): This is a great opportunity to connect with the community and maintainers - ## Formatting Guidelines When contributing an official doc or referencing dev containers in your projects, please consider the following guidelines: @@ -65,3 +59,9 @@ We use the following [labels](https://github.com/devcontainers/spec/labels): - `finalization`: Proposals we intend to make part of the spec. [Milestones](https://github.com/devcontainers/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. + +## Community Engagement +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: +- [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) +- [Community Slack channel](https://aka.ms/dev-container-community): This is a great opportunity to connect with the community and maintainers +- 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/devcontainers.github.io/edit/gh-pages/contributing.md) too! From a0e112745fcc6d67c5e92bbf5ab1fbbd27c01a26 Mon Sep 17 00:00:00 2001 From: Brigit Murtaugh Date: Mon, 6 Nov 2023 15:03:29 -0800 Subject: [PATCH 4/4] Update contributing.md Co-authored-by: Samruddhi Khandale --- contributing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index 543d07ee..8b97c103 100644 --- a/contributing.md +++ b/contributing.md @@ -64,4 +64,5 @@ We use the following [labels](https://github.com/devcontainers/spec/labels): 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: - [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) - [Community Slack channel](https://aka.ms/dev-container-community): This is a great opportunity to connect with the community and maintainers -- 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/devcontainers.github.io/edit/gh-pages/contributing.md) too! +- 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! +