Skip to content

Commit 530649a

Browse files
Copilotabdurriq
andcommitted
Document single-collection rule and OCI reference format for contributors
Co-authored-by: abdurriq <137001048+abdurriq@users.noreply.github.com>
1 parent 2e73e46 commit 530649a

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ _If your PR contributes a new collection, please utilize this checklist:_
3131
- [ ] Maintainer name
3232
- [ ] Maintainer contact link (i.e. link to a GitHub repo, email)
3333
- [ ] Repository URL
34-
- [ ] OCI Reference
34+
- [ ] OCI Reference (must be the collection root, e.g. `ghcr.io/<owner>/<repo>` — one entry per repository, not one per Feature; do not include `http://` or `https://`)
3535
- [ ] I acknowledge that this collection provides new functionality, distinct from the existing collections part of this index.

_posts/2022-11-01-author-a-feature.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,6 @@ If you'd like your Features to appear in our [public index](/features) so that o
107107
* Open a PR to modify the [collection-index.yml](https://github.com/devcontainers/devcontainers.github.io/blob/gh-pages/_data/collection-index.yml) file
108108
* Features housed in other OCI Artifact container registries can be included as long as they can be downloaded without a login.
109109

110+
> **Note:** Add a **single entry per repository**, regardless of how many Features it contains. The `ociReference` should be the collection namespace root — e.g., `ghcr.io/<owner>/<repo>`**not** a path to an individual Feature (e.g., avoid `ghcr.io/<owner>/<repo>/<featureName>`). The site will automatically discover all Features in the collection from that one entry. The `ociReference` value must not include a URL scheme such as `http://` or `https://`.
111+
110112
Feature collections are scanned to populate a Feature index on the [containers.dev site](/features) and allow them to appear in Dev Container creation UX in [supporting tools](https://containers.dev/supporting) like [VS Code Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and [GitHub Codespaces](https://github.com/features/codespaces).

0 commit comments

Comments
 (0)