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.

Sign up for GitHub

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

Jump to bottom

Add a devcontainer for Bikeshed development. #2452

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add a devcontainer for Bikeshed development. #2452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ef402e
Add a devcontainer for Bikeshed development.
jyasskin Jan 31, 2023
10dd620
Add some VSCode extensions to the devcontainer.
jyasskin Jan 31, 2023
1f9f065
Mention the devcontainer in CONTRIBUTING.
jyasskin Jan 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python
{
"name": "Bikeshed",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/python:3",

// Features to add to the dev container. More info: https://containers.dev/features.
"features": {"ghcr.io/devcontainers/features/github-cli:1": {}},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// See https://containers.dev/implementors/json_reference/#lifecycle-scripts.
"updateContentCommand": "pip3 install --user -r requirements-dev.txt",
"postStartCommand": "bikeshed update",
// Configure tool-specific properties.
"customizations": {
"vscode": {
"extensions": [
"eamodio.gitlens",
"GitHub.vscode-pull-request-github",
"matangover.mypy",
"ms-python.black-formatter",
"ms-python.flake8",
"ms-python.pylint"
]
}
}

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ I find it simple to use,
and it's what I use to develop Bikeshed,
so it has a high chance of working correctly.)

If you use Visual Studio Code,
you can [open a Bikeshed development environment
in a local container](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/speced/bikeshed).

See [my blog post on cleanly handling a fork](https://www.xanthir.com/b4hf0)
for guidance on how to fork responsibly
when you're making small changes to an active project;
Expand Down Expand Up @@ -89,4 +93,4 @@ and keep `requirements.txt` in sync with the lockfile.
Whenever new packages are installed or updated,
run `pipenv lock` (to generate a `Pipfile.lock`)
and `pipenv lock -r` (to generate a `requirements.txt`)
and commit those alongside the new code that requires it.
and commit those alongside the new code that requires it.