Add devcontainer.json to ease local dev environment setup#13638
Merged
diemol merged 4 commits intoSeleniumHQ:trunkfrom Mar 4, 2024
Merged
Add devcontainer.json to ease local dev environment setup#13638diemol merged 4 commits intoSeleniumHQ:trunkfrom
diemol merged 4 commits intoSeleniumHQ:trunkfrom
Conversation
diemol
requested changes
Feb 29, 2024
Member
diemol
left a comment
There was a problem hiding this comment.
Wait, but now you are replacing the content. Someone might want to use the Dockerfile. Can you please leave your added content and merge it with what already exists?
Contributor
Author
|
My bad. I thought that the main purpose of the Docker image was to create a Dev Container. I restored the original section. |
diemol
approved these changes
Mar 4, 2024
Added devcontainer.json
Moved devcontainer.json to devcontainer folder
Section 'Using Docker Image' rephrased to include Dev Container setup documentation
Dev Container section separated from Docker Image section
578a632 to
5ece144
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adding a Dev Container configuration to ease local dev environment setup.
Motivation and Context
I recently contributed to the Selenium project for the first time (see #13583). I opted for the Dev Container variant to set up my local dev environment. This worked very well, but I had to create my own devcontainer.json to be able to work with my IDE and Dev Container. To make it easier to get started, especially for first time contributors, I would like to add a devcontainer.json to the Selenium project. This minimal devcontainer.json has two advantages:
IDEs will recognize that Dev Containers are supported when opening the project and may offer to create the container. Here is an example from Visual Studio Code:
contributors who do not have much knowledge of Dev Containers can use the devcontainer.json and the documentation link it contains as a starting point for their local dev environment.
According to the Dev Container documentation, I have placed the file in the preferred folder
.devcontainer. Both IntelliJ IDEA and Visual Studio Code recognize this Dev Container configuration correctly.Types of changes
Checklist