Fixes #946 - Add devcontainer configuration#974
Open
cmaneu wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a contributor devcontainer and expands contributor documentation around the docs workflow.
Changes:
- Adds a new
.devcontainerconfiguration with Python 3.11, common CLI features, VS Code settings, and a setup command. - Documents how to build, serve, and extend the MkDocs documentation locally in
CONTRIBUTING.md. - Adds an unreleased changelog entry describing the devcontainer and docs contribution updates.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds a new section explaining the local MkDocs documentation workflow and contribution guidelines. |
.devcontainer/devcontainer.json |
Introduces the new devcontainer image, features, editor settings, and setup commands. |
.changes/unreleased/docs-20260505-135611.yaml |
Adds the unreleased changelog entry for this PR. |
| } | ||
| } | ||
| }, | ||
| "postCreateCommand": "npm install -g changie && uv sync --dev", |
Comment on lines
+98
to
+103
| To preview documentation changes locally: | ||
|
|
||
| ```sh | ||
| uv run mkdocs serve | ||
| ``` | ||
|
|
| @@ -0,0 +1,31 @@ | |||
| { | |||
| "name": "fabric-cicd", | |||
| "image": "mcr.microsoft.com/devcontainers/python:3.11", | |||
| @@ -0,0 +1,8 @@ | |||
| kind: docs | |||
| body: Add devcontainer and a section about contributing to documentation | |||
ayeshurun
reviewed
May 27, 2026
| } | ||
| }, | ||
| "postCreateCommand": "npm install -g changie && uv sync --dev", | ||
| "forwardPorts": [8000] |
Comment on lines
+5
to
+11
| "ghcr.io/devcontainers-extra/features/git-lfs:1": {}, | ||
| "ghcr.io/devcontainers/features/node:2.0.0": {}, | ||
| "ghcr.io/devcontainers/features/powershell:2.0.2": {}, | ||
| "ghcr.io/devcontainers/features/azure-cli:1": {}, | ||
| "ghcr.io/devcontainers/features/github-cli:1": {}, | ||
| "ghcr.io/devcontainers-extra/features/uv:1": {}, | ||
| "ghcr.io/devcontainers-extra/features/ruff:2": {} |
Contributor
There was a problem hiding this comment.
besides ruff, uv and node, do we need the rest?
| @@ -0,0 +1,8 @@ | |||
| kind: docs | |||
Contributor
There was a problem hiding this comment.
this is not affecting the package, hence no need of changelog entry. added skip changelog label to skip the validation.
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
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
This PR adds a devcontainer with python (including uv and ruff).
Linked Issue (REQUIRED)
#946