/devcontainers-contrib-templates

📂 Pre-made .devcontainer folders for starting your next project

Primary LanguageShellMIT LicenseMIT

Community devcontainer templates

🥧 Pre-baked @devcontainers configurations to get you started

Docs site | Chat

🔧 80% of the configuration you'll ever need
💻 Ready to go with GitHub Codespaces
🚀 Quickly get up-and-running with a devcontainer
🐳 No need to mess with a Dockerfile

Usage

Codespaces Devcontainers

After creating a GitHub Codespace (or a devcontainer in VS Code), open the Command Palette to find the Dev Containers: Add Dev Container Configuration Files... command. After you run it, VS Code will guide you through the creation of a .devcontainer/devcontainer.json file!

Make sure you click the Show All Definitions... option to see our unofficial templates!

Development

GitHub.dev

📢 We want you to contribute!

Guess what? You don't even need to leave your browser to add a feature template! Since these devcontainer-template.json files are just JSON files, we don't need a full IDE with a terminal; all we need is a JSON text editor.

To add a feature, all you need to do is...

  1. Fork this repository.
  2. Press . (period) on your keyboard to open GitHub.dev.
  3. Make any changes.
  4. Commit to your forked repo.
  5. Open a Pull Request to this repo.
  6. Profit! 🎉

📙 You can find more information in the contributing guide

Docs website

If you want to contribute to the docs website, you'll actually need to spin up a local development environment. We do offer a preconfigured devcontainer for GitHub Codespaces or VS Code Dev Containers, but you can use anything that fits the requirements described in the devcontainer.json file.

⚠️ All the docs/tools/ scripts assume that you're current working directory is the docs/ folder, not the root of the repository. It's like a subproject!