How can I contribute to dotfiles.github.io?

Updated

dotfiles.github.io accepts three kinds of contributions: feature requests, issues, and patches. The site itself describes this under its "Contribute" section, inviting anyone who wants to help to submit a feature request, open an issue, or submit a patch. If you have an idea for improving the guide, found something broken or outdated, or want to fix or add content directly, one of those three channels is the intended route.

The three contribution paths

Path Best for What you're doing
Feature request New ideas, additions, structural suggestions Proposing something the site doesn't have yet
Issue Bugs, broken links, outdated info, questions Reporting a problem or starting a discussion
Patch Concrete fixes or content changes Submitting the actual change

The site does not publish a separate contributor guide, code of conduct, or step-by-step workflow beyond this. So the practical answer is: use the project's GitHub repository (the site is hosted on GitHub and the "Contribute" section links to these actions) and pick the channel that matches your intent.

Choosing the right channel

Submit a feature request

Use this when you want something added or changed in concept — for example, a new category of tutorials, a tool that should be listed, or a reorganization of the navigation. A feature request is a proposal, not a change, so describe what you want and why it helps readers.

Open an issue

Use this for anything that is wrong or unclear: a dead link, a tool that no longer works as described, a tutorial that has gone stale, or a question about how the site is organized. Issues are also the right place to discuss before writing code, so you don't invest effort in a patch that doesn't fit the project's direction.

Submit a patch

Use this when you already know the fix. A patch is the concrete change — corrected text, a new entry, a fixed link. Because the site is a GitHub-hosted project, the usual mechanism is a pull request against the repository, but the site's own wording is simply "submit a patch," so follow whatever contribution flow the repository itself specifies.

A practical sequence

  1. Check what already exists. The site is organized into tutorials, general-purpose utilities, tool-specific frameworks, bootstrap repositories, inspiration, tips and tricks, and an FAQ. If your idea fits an existing section, note where.
  2. Decide the channel. Idea → feature request. Problem → issue. Fix in hand → patch.
  3. Be specific. For a feature request, say what and why. For an issue, give the page and what's wrong. For a patch, keep the change focused on one thing.
  4. Submit through the repository. The "Contribute" section links to feature requests, issues, and patches; use those links rather than contacting maintainers out of band.

Common sticking points

  • No published contributor guide. The site doesn't spell out formatting rules or a review process, so match the existing style of the page you're editing and keep changes minimal.
  • "Patch" vs. "pull request." The site says "patch." On a GitHub-hosted project that normally means a pull request, but confirm against the repository's own instructions before assuming a specific workflow.
  • Discussion before code. If your change is large or changes structure, opening an issue first avoids rework.

What you're contributing to

The site is described as "your unofficial guide to dotfiles on GitHub," covering backup, restore, and sync of preferences and settings, learning from the community, and sharing what you've learned. Contributions that improve those goals — better tutorials, more accurate tool listings, clearer navigation — fit the project's stated purpose.