devcontainers-community / templates Goto Github PK

This seems to be a good first template to add. It's been discussed in https://github.com/orgs/devcontainers-community/discussions/1#discussioncomment-5351589

Here's a tentative todo thingy:

• Reach out to the original maintainer @nathancarter
• Get their permission to move/improve/do stuff
• Add the actual code content into this repo
• OPTIONAL: Deprecate and/or document the change in the original location? unsure of how to go about this. I wasn't involved with devcontainers-related stuff until Nov 2022 which was after the deprecation of https://github.com/microsoft/vscode-dev-containers i think... @eitsupi will probably need to assist me and/or do this

@nathancarter Are you interested in being added as a collaborator, or would you prefer to make it more of a "transferring the torch" kinda thing?

It would be nice to be able to run tests locally to make sure everything "kinda works". Right now I don't think this is possible.

• Create some kind of tools/test.sh file
• Move logic from https://github.com/devcontainers-community/templates/tree/main/.github/actions/smoke-test to there
• Make sure it still works
• Add a GitHub Action to test changes

This means making it "ready for prime time" before doing so though, so this could be a while...

I like to use GitHub Pages for user-facing docs (things like JSDoc sites, an example playground, etc.) and GitHub wikis for developer-facing docs (things like conventions, layout, architecture, project history, etc.)

In order to do this in a way that works well with github/git PRs and stuff, it's nice to have a wiki/ dir (or docs/ or something) mirror to the GitHub wiki itself.

Here's a todo thing:

• Find a GitHub Action to deploy a folder to the wiki
• Use it
• Write some of those wiki pages

Wiki page ideas:

• How to create a template
• Styleguide.md (commit conventions, formatters, etc.)

related to #10 #8 #7

As referenced in the Templates page, the Dart dev container is referencing https://github.com/devcontainers-community/templates/tree/main/src/dart which does not exist

Since #24 and #25 seem to have stalled, let's jump ahead
https://github.com/orgs/microsoft/packages?q=vscode-dev-containers&sort_by=downloads_desc

it does only have 841 downloads, but hey! it's another template!

todo thingy

• reach out to previous contributors - not really any listed https://github.com/microsoft/vscode-dev-containers/tree/main/containers/dart
• get their permission to move/adopt here (i assume yes?)
• import the devcontainer-template.json from https://github.com/microsoft/vscode-dev-containers/blob/main/containers/dart/devcontainer-template.json
• import the https://github.com/microsoft/vscode-dev-containers/blob/main/containers/dart/.devcontainer/devcontainer.json
• import dockerfile https://github.com/microsoft/vscode-dev-containers/blob/main/containers/dart/.devcontainer/Dockerfile

other related ideas

• move from dockerfile to devcontainer.json with features
• get rid of the library-scripts folder?
• change-up some of the options. right now its zsh and apt-update.
• ?? create a 'dart' feature? https://dart.dev/get-dart

closes #28

A large number of Linter errors are currently occurring and must be corrected.

Idea from @jcbhmr and @eitsupi in #8 (comment)

ideas of things to include:

• what the thing is (like "deno template" -- what is deno?)
• links to get started with thing (like "jupyter template" -- getting started with python datascience)
• options documentation (answer things like "why do I care about imageVariant?")

ideas of where to put it:

• in a wiki (https://github.com/devcontainers-community/templates/wiki) #11
• in contributing.md
• in readme.md
• some other markdown file

but I think this is something that should be done, hence this issue tracking the todo. see discussion in #8 about more/other ideas

Now that there's a first template, there (probably) should come a second. 😉 Preferably another one from https://github.com/microsoft/vscode-dev-containers ? Right now, the forerunners are

• deno #24
• azure py #25

heres a rough outline

• Define what's worthy of a template
• Create the first template #2
• Figure out what the second template should be
• Write a devcontainer-template.json for it
• Add a test.sh
• Document the template in NOTES.md
• Open a PR to this repo
• Merge it
• Publish it

@eitsupi miss anything?

I recommend MegaLinter.
https://megalinter.io/latest/

I have often used Super-Linter (https://github.com/github/super-linter, like https://github.com/rocker-org/devcontainer-templates/blob/9f90b59bf0ed97dde1ffc048e0ae98a5734dc5b5/.github/workflows/lint.yaml), but I prefer to set up MegaLinter because it is more flexible in configuration and updated more frequently.

For now, I protected the main branch of https://github.com/devcontainers-community/templates and set only allow squash merging.

If we wanted to restrict the PR title, we could use the following action.
https://github.com/amannn/action-semantic-pull-request

Originally posted by @eitsupi in devcontainers-community/.github#4 (reply in thread)

problem: the test.sh is confusing
i.e. not everyone (me included) know what the heck happens in that magic bash script 🤣

this isn't a major problem, but it is a thing to do that i think is a good idea. 😉

solution 1: make it a python script instead with more friendly programming language syntax
solution 2: add a bunch of comments

i vote solution 1. i originally tried to do this in the #20 pr, but was too complicated at the time. time for another crack at it?