Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add instructions to update collection-index.yml to CONTRIBUTING.md

Open
#242 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
markdown, yaml
Domain
documentation

Research direction

Read CONTRIBUTING.md and compare the collection-index.yml instructions at https://containers.dev/collections. Add equivalent guidance to CONTRIBUTING.md, covering what to add and how to do it. Done means contributors can find the collection-index.yml instructions in this repository's contributing guide.

Written by the indexing model from the issue text.

Description

Right now the only place with instructions on what to add to the collections-index.yml file and how to do it are at https://containers.dev/collections. I think that there should be a similar blurb added to the CONTRIBUTING.md file for this repository.

Sidenote: it currently seems like the contributing guide for this repo focuses very heavily on the specification itself, and not the docs website that makes up the bulk of this repo.

https://github.com/devcontainers/devcontainers.github.io/blob/4b6f855e772e8e6cfa4fc5fc38460e01fb01443a/contributing.md

Dominant language
HTML
Stars
207
Forks
435
Avg merge
1d 17h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from devcontainers/devcontainers.github.io

All issues in devcontainers/devcontainers.github.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.