Skip to content

Commit 1606dd0

Browse files
bamurtaughbamurtaugh
and
bamurtaugh
authored
Update docs and guidance for contributions (devcontainers#382)
* Update contrib process, docs * Formatting * Consistency --------- Co-authored-by: bamurtaugh <[email protected]>
1 parent 9e09d36 commit 1606dd0

File tree

5 files changed

+79
-9
lines changed

5 files changed

+79
-9
lines changed
+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
📖 Before submitting a Pull Request, please ensure you've read the Contributing Guide: https://containers.dev/implementors/contributing/
3+
-->
4+
5+
## What type of PR is this?
6+
7+
- [ ] Add a new dev container collection
8+
- [ ] Update to an existing dev container collection
9+
- [ ] Documentation/spec update
10+
- [ ] Other containers.dev site update (UX, layout, etc)
11+
12+
## Related Issues
13+
14+
<!--
15+
For pull requests that relate or close an issue, please include them
16+
below. For example: "closes #1234" would connect the current pull
17+
request to issue 1234. When we merge the pull request, Github will
18+
automatically close the issue.
19+
-->
20+
21+
- Related Issue #
22+
- Closes #
23+
24+
## Description
25+
26+
_Please replace this line with a description of your PR._
27+
28+
### Collection checklist
29+
_If your PR contributes a new collection, please utilize this checklist:_
30+
- [ ] Collection name
31+
- [ ] Maintainer name
32+
- [ ] Maintainer contact link (i.e. link to a GitHub repo, email)
33+
- [ ] Repository URL
34+
- [ ] OCI Reference
35+
- [ ] I acknowledge that this collection provides new functionality, distinct from the existing collections part of this index.

Diff for: _implementors/contributing.md

+27-4
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ index: 9
88

99
We're excited for your contributions to the Dev Container Specification! This document outlines how you can get involved. We also welcome you to join our [community Slack channel](https://aka.ms/dev-container-community).
1010

11-
## <a href="#contribution-approaches" name="contribution-approaches" class="anchor"> Contribution approaches </a>
11+
## <a href="#contribution-approaches" name="contribution-approaches" class="anchor"> Spec Contribution approaches </a>
1212

13-
- Propose the change via an [issue](https://github.com/devcontainers/spec/issues) in the [spec repo](https://github.com/devcontainers/spec). Try to get early feedback before spending too much effort formalizing it.
14-
- More formally document the proposed change in terms of properties and their semantics. Look to format your proposal like our [devcontainer.json reference](../json_reference), which is a JSON with Comments (jsonc) format.
13+
If you'd like to contribute a change or addition to the spec, you may follow the guidance below:
14+
- Propose the change via an [issue](https://github.com/devcontainers/spec/issues) in this repository. Try to get early feedback before spending too much effort formalizing it.
15+
- More formally document the proposed change in terms of properties and their semantics. Look to format your proposal like our [devcontainer.json reference](https://aka.ms/devcontainer.json).
1516

16-
Here is a sample proposal:
17+
Here is a sample:
1718

1819
| Property | Type | Description |
1920
|:------------------|:------------|:------------|
@@ -43,6 +44,20 @@ Tool-specific properties are contained in namespaces in the `"customizations"` p
4344

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

47+
### <a href="#formatting-guidelines" name="formatting-guidelines" class="anchor"> Formatting Guidelines </a>
48+
49+
When contributing an official doc or referencing dev containers in your projects, please consider the following guidelines:
50+
51+
- Refer to the spec as the "Development Container Specification"
52+
- All capital letters
53+
- Singular "Container" rather than plural "Containers"
54+
- The term "dev container" shouldn't be capitalized on its own
55+
- It should only be capitalized when referring to an official tool title, like the VS Code Dev Containers extension
56+
- Signify `devcontainer.json` is a file type through backticks
57+
- Features and Templates should always be capitalized
58+
- Refer to the CLI as the "Dev Container CLI" (note the caps)
59+
- Use bolding for emphasis sprinkled throughout sections, rather than try to use it to always bold certain terms
60+
4661
## <a href="#review-process" name="review-process" class="anchor"> Review process </a>
4762

4863
We use the following [labels](https://github.com/devcontainers/spec/labels) in the spec repo:
@@ -51,3 +66,11 @@ We use the following [labels](https://github.com/devcontainers/spec/labels) in t
5166
- `finalization`: Proposals we intend to make part of the spec.
5267

5368
[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.
69+
70+
## <a href="#community-engagement" name="community-engagement" class="anchor"> Community Engagement </a>
71+
72+
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:
73+
- [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)
74+
- [Community Slack channel](https://aka.ms/dev-container-community): This is a great opportunity to connect with the community and maintainers
75+
- 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!
76+
- Community collections: You can contribute your own [Templates](https://containers.dev/implementors/templates-distribution/#distribution) and [Features](https://containers.dev/implementors/features-distribution/#distribution) to our [community index](https://containers.dev/collections)!

Diff for: contributing.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# How to Contribute to the Dev Container Specification
22

3-
We're excited for your contributions to the dev container specification! This document outlines how you can get involved.
3+
We're excited for your contributions to the Dev Container Specification! This document outlines how you can get involved. We also welcome you to join our [community Slack channel](https://aka.ms/dev-container-community).
44

5-
## Contribution approaches
5+
## Spec contribution approaches
66

77
If you'd like to contribute a change or addition to the spec, you may follow the guidance below:
88
- Propose the change via an [issue](https://github.com/devcontainers/spec/issues) in this repository. Try to get early feedback before spending too much effort formalizing it.
@@ -16,7 +16,7 @@ Here is a sample:
1616

1717
- PRs to the [schema](https://github.com/microsoft/vscode/blob/main/extensions/configuration-editing/schemas/devContainer.schema.src.json), i.e code or shell scripts demonstrating approaches for implementation.
1818

19-
Once there is discussion on your proposal, please also open and link a PR to update the [devcontainer.json reference doc](https://github.com/microsoft/vscode-docs/blob/main/docs/remote/devcontainerjson-reference.md). When your proposal is merged, the docs will be kept up-to-date with the latest spec.
19+
Once there is discussion on your proposal, please also open and link a PR to update the [devcontainer.json reference doc](https://aka.ms/devcontainer.json). When your proposal is merged, the docs will be kept up-to-date with the latest spec.
2020

2121
### Contributing tool-specific support
2222

@@ -53,7 +53,7 @@ When contributing an official doc or referencing dev containers in your projects
5353

5454
## Review process
5555

56-
We use the following [labels](https://github.com/devcontainers/spec/labels):
56+
We use the following [labels](https://github.com/devcontainers/spec/labels) in the spec repo:
5757

5858
- `proposal`: Issues under discussion, still collecting feedback.
5959
- `finalization`: Proposals we intend to make part of the spec.
@@ -65,4 +65,4 @@ There are several additional options to engage with the dev container community,
6565
- [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)
6666
- [Community Slack channel](https://aka.ms/dev-container-community): This is a great opportunity to connect with the community and maintainers
6767
- 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!
68-
68+
- Community collections: You can contribute your own [Templates](https://containers.dev/implementors/templates-distribution/#distribution) and [Features](https://containers.dev/implementors/features-distribution/#distribution) to our [community index](https://containers.dev/collections)!

Diff for: features.html

+6
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ <h1 style="margin-left: auto;margin-right: auto;">Available Dev Container Featur
1818
Please note that if you need to report a Feature, you should do so through the registry hosting the Feature.
1919
</p>
2020

21+
<p>
22+
To add your own collection to this list, please create a PR editing <a
23+
href="https://github.com/devcontainers/devcontainers.github.io/blob/gh-pages/_data/collection-index.yml">this
24+
yaml file</a>.
25+
</p>
26+
2127
<input type="text" id="searchInput" placeholder="Search">
2228
<br>
2329
<br>

Diff for: templates.html

+6
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ <h1 style="margin-left: auto;margin-right: auto;">Available Dev Container Templa
1616
Please note that if you need to report a Template, you should do so through the registry hosting the Template.
1717
</p>
1818

19+
<p>
20+
To add your own collection to this list, please create a PR editing <a
21+
href="https://github.com/devcontainers/devcontainers.github.io/blob/gh-pages/_data/collection-index.yml">this
22+
yaml file</a>.
23+
</p>
24+
1925
<input type="text" id="searchInput" placeholder="Search">
2026
<br>
2127
<br>

0 commit comments

Comments
 (0)