Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic devcontainer config #4845

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

krissetto
Copy link
Contributor

- What I did

  • Added an initial devcontainer configuration to facilitate development on the codebase;
  • Updated README/CONTRIBUTING docs with some extra info on setting up a local development environment and using a devcontainer;
  • Added dependabot config to check for updates weekly

- How to verify it

  • Pull and test the config using an ide like vscode
  • Proof-read doc changes :)

- Description for the changelog

Added initial devcontainer configuration

- A picture of a cute animal (not mandatory but encouraged)

photo_5783028234496098599_y

Signed-off-by: krissetto <chrisjpetito@gmail.com>
@krissetto krissetto self-assigned this Feb 2, 2024
@codecov-commenter
Copy link

Codecov Report

Merging #4845 (1d92d8c) into master (2936816) will increase coverage by 1.69%.
Report is 691 commits behind head on master.
The diff coverage is 61.90%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4845      +/-   ##
==========================================
+ Coverage   59.58%   61.28%   +1.69%     
==========================================
  Files         288      287       -1     
  Lines       24821    20029    -4792     
==========================================
- Hits        14790    12275    -2515     
+ Misses       9145     6864    -2281     
- Partials      886      890       +4     

Comment on lines +1 to +3
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/go
{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSON doesn't allow comments 🤔 should this have a jsonc file-extension ? (is that the official extension for it?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, the official devcontainers spec defines the file as a JSON with Comments, but using the .json extension. I know.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😬 that feels very "YOLO - works for us, just not for everyone else"

* [Reporting Security Issues](#reporting-security-issues)
* [Design and Cleanup Proposals](#design-and-cleanup-proposals)
* [Reporting Issues](#reporting-other-issues)
* [Quick Contribution Tips and Guidelines](#quick-contribution-tips-and-guidelines)
* [Community Guidelines](#docker-community-guidelines)

## Development environment
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another option is cloning the CLI repo inside your global GOPATH. Although I guess we will move to go modules soonish?

mkdir -p $GOPATH/src/github.com/docker/
cd $GOPATH/src/github.com/docker
git clone git@github.com:docker/cli.git

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants