From 0e8dc7b582523d3a02ad27949d3b47c43c789918 Mon Sep 17 00:00:00 2001 From: Allison Weins <3174849+2percentsilk@users.noreply.github.com> Date: Fri, 25 Jun 2021 20:07:24 +0000 Subject: [PATCH] Added note on the new recommended extension --- .vscode/extensions.json | 1 + CONTRIBUTING.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index beeb8fc3..7355e98b 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -4,6 +4,7 @@ // List of extensions which should be recommended for users of this workspace. "recommendations": [ + // We recommend this extension for contributors to assist with the correct styling and formatting of files in this repo. "EditorConfig.EditorConfig", ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7888b20a..e5cd304e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,8 @@ Since devcontainer.json can be commited to a source code repository, the definit If the definition is too similar to others, consider contributing a PR to improve an existing one instead. If the scenario is too specific consider generalizing it and making it more broadly applicable. +To help speed up PRs, we encourage you to install the recommended [EditorConfig extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig). This will ensure your changes adhere to our style guidelines. + ### A note on referenced images and Dockefile contents One of the things we want to be sure anyone using a definition from this repository is able to do is understand what is inside it. In general, images referenced by Dockerfiles, Docker Compose files, or devcontainer.json in this repository should reference known base Docker, Microsoft, or runtime/platform community/vendor managed base images. These images are already well maintained, regularly patched, and maintained by the platform/runtime community or vendor. From there you can use a Dockerfile to add any additional contents.