Skip to content
This repository was archived by the owner on Nov 30, 2023. It is now read-only.

Commit 3b30202

Browse files
committed
readme and contributing review
1 parent a76d632 commit 3b30202

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Contributing
22

3-
There are many ways for you to contribute to VS Code Remote Development. This document will outline a number of ways you can get involved.
3+
This document outlines a number of ways you can get involved.
44

55
## Contributing Dev Container Definitions
66

7-
Have a container set up you're proud of and would like to share? Want to see some changes made to an existing definition We love contributions! Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
7+
Have a container set up you're proud of and would like to share? Want to see some changes made to an existing definition? We love contributions! Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
88

99
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
1010

@@ -35,13 +35,13 @@ If you want to create a new definition:
3535
3636
See the [VS Code Remote Development documentation](https://aka.ms/vscode-remote/docker) for information on the expected contents of `devcontainer.json` and how it relates to other files listed above.
3737
38-
Note that any additional assets can be included as needed, but keep in mind that these will overlay on top of an existing project. Keeping these files in the `.devcontainer` should reduce the chances of something conflicting but note that any command that are run are relative to the root of the project, so you'll need to include `.devcontainer` in any path references.
38+
Note that any additional assets can be included as needed, but keep in mind that these will overlay on top of an existing project. Keeping these files in the `.devcontainer` folder should reduce the chances of something conflicting but note that any command that are run are relative to the root of the project, so you'll need to include `.devcontainer` in any path references.
3939
4040
VS Code respects [`.npmignore`](https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package) as a way to keep certain content out of projects when your definition is used. Add anything you don't want copied across into this file in [glob](https://facelessuser.github.io/wcmatch/glob/) form.
4141
4242
Finally, create a `README.md` in the folder with a brief description of the purpose of the container definition and any manual steps required to use it.
4343
44-
4. Commit your changes and submit a PR - we'll take a look at it, provide any needed feedback, and then merge it in! We appreciate any and all feedback!!
44+
4. Commit your changes and submit a PR - we'll take a look at it, provide any needed feedback, and then merge it in. We appreciate any and all feedback!
4545
4646
### Developing and testing a definition
4747
@@ -55,7 +55,7 @@ VS Code Remote provides a straight forward development loop for creating and edi
5555
5656
Note that if you make major changes, Docker may occasionally not pick up your edits. If this happens, you can delete the existing container and image, open the folder locally, and go to step 2 above. Install the [Docker extension](https://marketplace.visualstudio.com/items?itemName=PeterJausovec.vscode-docker) locally (when not in a container) to make this easy. While you can use Docker from inside a container by forwarding the Docker unix socket and installing the CLI in the container (see [Docker-in-Docker](containers/docker-in-docker)), you'll likely be removing the container you are actually using so this approach will not work well in this case.
5757
58-
Finally, after you get your container up and running, you can test it by adding test assets into the definition folder as long as they are referenced in the `.devcontainer/ignore` file in [glob](https://facelessuser.github.io/wcmatch/glob/) form ith paths relative the root of the folder. By convention, most definitions place test assets in a `test-project` folder and this path is referenced in the template `ignore` files.
58+
Finally, after you get your container up and running, you can test it by adding test assets into the definition folder and add them to the `.devcontainer/ignore` file in [glob](https://facelessuser.github.io/wcmatch/glob/) form relative to the root of the folder. By convention, most definitions place test assets in a `test-project` folder and this path is referenced in the template `ignore` files.
5959
6060
### Speeding up container provisioning
6161
@@ -65,15 +65,15 @@ Once you've published your container image, just update `devcontainer.json` to r
6565
6666
## Contributing to Documentation
6767
68-
The majority of VS Code Remote's documentation can be found in the [VS Code docs repository](https://github.com/Microsoft/vscode-docs). This is usually the best place to contribute, but if you have a correction or suggestion for the countent found here, we welcome your contributions.
68+
The majority of VS Code Remote's documentation can be found in the [VS Code docs repository](https://github.com/Microsoft/vscode-docs). This is usually the best place to contribute, but if you have a correction or suggestion for the content found here, we welcome your contributions.
6969
7070
## Reporting Issues
7171
7272
Have you identified a reproducible problem in a dev container definition? We want to hear about it! Here's how you can make reporting your issue as effective as possible.
7373
7474
### Identify Where to Report
7575
76-
This repository is specifically for dev container definitions. If you are not looking to report an issue related to a container definition, you may want to report the an issue in the feedback repository for [VS Code Remote Development extensions](https://github.com/Microsoft/vscode-remote-release). Or you may be looking for the [VS Code OSS](https://github.com/Microsoft/vscode) repository. However, note that, the VS Code project is distributed across multiple repositories. See the list of [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects) if you aren't sure which repo is correct.
76+
This repository is specifically for dev container definitions. If you are not looking to report an issue related to a container definition, you may want to report the issue in the feedback repository for [VS Code Remote Development extensions](https://github.com/Microsoft/vscode-remote-release). Or you may be looking for the [VS Code OSS](https://github.com/Microsoft/vscode) repository. However, note that, the VS Code project is distributed across multiple repositories. See the list of [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects) if you aren't sure which repo is correct.
7777
7878
### Look For an Existing Issue
7979
@@ -114,9 +114,9 @@ Please include the following with each issue:
114114
115115
* A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally
116116
117-
* **Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.
117+
* **Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. `.gif`) is not sufficient.
118118
119-
* Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools)
119+
* Errors from the Dev Tools Console (open from the menu: **Help > Toggle Developer Tools**)
120120
121121
### Final Checklist
122122
@@ -132,7 +132,7 @@ Don't feel bad if the developers can't reproduce the issue right away. They will
132132
133133
### Follow Your Issue
134134
135-
Once submitted, your report will go into the a similar [issue tracking](https://github.com/Microsoft/vscode/wiki/Issue-Tracking) workflow that is used for the core VS Code project. Be sure to understand what will happen next, so you know what to expect, and how to continue to assist throughout the process.
135+
Once submitted, your report will go into a similar [issue tracking](https://github.com/Microsoft/vscode/wiki/Issue-Tracking) workflow that is used for the VS Code project. Be sure to understand what will happen next, so you know what to expect, and how to continue to assist throughout the process.
136136
137137
### Automated Issue Management
138138

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
A **development container** is a running [Docker](https://www.docker.com) container with a well-defined tool/runtime stack and its prerequisites. The Remote - Containers extension in the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension pack allows you to open any folder inside (or mounted into) a dev container and take advantage of VS Code's full development feature set.
1313

14-
This repository contains a set of **dev container definitions** to help get you up and running with a containerized environment. The definitions describe the appropriate container image, runtime arguments for starting the container, and VS Code extensions that should be installed. They can help you get started or be used as examples for adapting your own configuration to different situations.
14+
This repository contains a set of **dev container definitions** to help get you up and running with a containerized environment. The definitions describe the appropriate container image, runtime arguments for starting the container, and VS Code extensions that should be installed. They can also be used as examples for adapting your own configuration to different situations.
1515

1616
## Using a definition
1717

@@ -25,7 +25,7 @@ To add a dev container definition in your project, you can either:
2525
and select either the **Remote-Containers: Create Container Configuration File...** or **Remote-Containers: Reopen Folder in Container** commands.
2626
4. Follow the directions and pick one of the existing development container definitions in this repository from the list.
2727

28-
- Or manually copy the contents of one of folders in the `containers` directory into your project. You should be able to copy just the `.devcontainer` folder and ignore everything else. See the definition's `README` for details.
28+
- Or manually copy the contents of one of the folders in the `containers` directory into your project. You should be able to copy just the `.devcontainer` folder and ignore everything else. See the definition's `README` for details.
2929

3030
## Adding a definition to an existing repository
3131

@@ -64,7 +64,7 @@ If you want to try a sample project which already has a dev container, check out
6464

6565
### Can I just reuse an existing container image or Docker / Docker Compose configuration?
6666

67-
Yes, if you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Create Container Configuration File...** from the Command Palette (F1). You'll be prompted to select a Dockerfile or Docker Compose file and customize from there. If you prefer, you can also start up the container and [attach to it](https://aka.ms/vscode-remote/containers/attach).
67+
Yes, if you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Create Container Configuration File...** from the Command Palette (<kbd>F1</kbd>). You'll be prompted to select a Dockerfile or Docker Compose file and customize from there. If you prefer, you can also start up the container and [attach to it](https://aka.ms/vscode-remote/containers/attach).
6868

6969
### What is the goal of `devcontainer.json`?
7070

@@ -74,7 +74,7 @@ A `devcontainer.json` file is similar to `launch.json` for debugging, but design
7474

7575
Have a question or feedback?
7676

77-
- Contribute or provide feedback for the [VS Code Remote Development extensions](https://github.com/Microsoft/vscode-remote-release/CONTRIBUTING.md).
77+
- Contribute or provide feedback for the [VS Code Remote Development extensions](https://github.com/Microsoft/vscode-remote-release/blob/master/CONTRIBUTING.md).
7878
- Search [existing issues](https://github.com/Microsoft/vscode-dev-containers/issues) with dev container definitions or [report a problem](https://github.com/Microsoft/vscode-dev-containers/issues/new).
7979
- Contribute a [development container definition](CONTRIBUTING.md#contributing-dev-container-definitions) to the repository.
8080

0 commit comments

Comments
 (0)