Skip to content

Developer contribution guide for Dev Containers CLI#1188

Open
brooke-hamilton wants to merge 1 commit intodevcontainers:mainfrom
brooke-hamilton:contributing-guide
Open

Developer contribution guide for Dev Containers CLI#1188
brooke-hamilton wants to merge 1 commit intodevcontainers:mainfrom
brooke-hamilton:contributing-guide

Conversation

@brooke-hamilton
Copy link
Copy Markdown

@brooke-hamilton brooke-hamilton commented Apr 6, 2026

Summary

This PR adds a developer contribution guide at docs/contributing-code.md that covers everything a contributor needs to know to work on the Dev Containers CLI.

What's Included

  • Prerequisites: Node.js >= 20, Docker, Git, yarn requirements
  • Development Environment Setup: Both dev container (recommended) and local setup options
  • Project Structure: Overview of the TypeScript sub-projects and their purposes
  • Development Workflow: Build commands, running the CLI locally, testing with Mocha/Chai
  • VS Code Integration: Build tasks, debug configurations, and editor settings
  • Troubleshooting: Common issues like Docker availability, node-pty build failures, and leftover test containers

Files Changed

  • docs/contributing-code.md (new file, 168 lines)

This guide complements the existing CONTRIBUTING.md which focuses on the proposal and specification process, while this new guide focuses on the hands-on development aspects.

Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@brooke-hamilton brooke-hamilton requested a review from a team as a code owner April 6, 2026 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant