Skip to content

Commit 88e7c0f

Browse files
committed
tweak to devcontainer.local note
1 parent 0d0a9ba commit 88e7c0f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/admin/templates/extending-templates/advanced-dev-containers.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,9 @@ component in the workspace.
7070
## Personal overrides
7171

7272
Let developers extend the repo’s `devcontainer.json` with an ignored (by Git) `devcontainer.local.json` file
73-
so they can add personal tools without changing the canonical config:
73+
so they can add personal tools without changing the canonical configuration:
7474

7575
```jsonc
76-
// devcontainer.local.json (in .gitignore)
7776
{
7877
"extends": "./devcontainer.json",
7978
"features": {
@@ -83,6 +82,9 @@ Let developers extend the repo’s `devcontainer.json` with an ignored (by Git)
8382
}
8483
```
8584

85+
Add the file name to your project's `.gitignore` or the user's
86+
[global exclude file](https://docs.github.com/en/get-started/git-basics/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer).
87+
8688
## Conditional startup
8789

8890
Use `coder_parameter` booleans to let workspace creators choose which dev containers start automatically,

0 commit comments

Comments
 (0)