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
Add Visual Studio Code Development Container #8016
Add Visual Studio Code Development Container #8016
Conversation
It's ignored if you're not using VS Code, but makes setting up a new box much faster.
Technically, this is not a documentation change. It is an enhancement to the repository's development workflow. |
Ok. I wasn't sure so flagged it as both. Thanks @ashmaroli. |
I'm not really sure how I feel about this. We provide zero help to people using other editors and I honestly wish we could decouple the actual code base from it's development environment and avoid the question of editor preference all together.
Fair point, on other projects I've worked on it's usually an all or nothing approach. I couldn't find anything specific about adding editor configuration in other issues, but it might be worth adding that to the docs for future if it's decided to keep them out. Just sharing as I found it useful for me. |
Please move the information added to the |
Per review from @ashmaroli. jekyll#8016 (comment)
Docs moved @ashmori. Thanks for the feedback. |
After thinking about this more, I don't think we should hold back from providing good editor support. It'll just be up to everybody to submit PRs for their chosen editor.
@jekyllbot: merge +dev |
Awesome! Thanks for the quick reviews @mattr- and @ashmaroli! :) |
You're welcome @MarkBennett |
Summary
Add files to create a Visual Studio Code development container which can be used to quickly get new contributors up and building the app. To use this you need to have Visual Studio Code and the Remote Development Extension Pack installed.
The development environment includes
gcc
,ruby
, andnodejs
. I've verified thatscript/cibuild
runs without errors. I've also added a section to the installation page describing how to setup VS Code to use this environment.From start to finish setting up a new development box is entirely automatic and takes about 5 minutes. Once you're done you can open a new terminal in the development container using the same shortcut keys as you would when using VS Code normally.
The editor files are all in
/.devcontainter
directory which can be ignored by other editors and team members.Context
I haven't been able to find any issues related to this, but please add them if I missed them.