fix: add Prerequisites section to CONTRIBUTING.md, point to Dev Container#20681
fix: add Prerequisites section to CONTRIBUTING.md, point to Dev Container#20681
Conversation
…uidance (#issue) - Add `## Prerequisites` section that directs users to Dev Container/Codespace - Clarify that generic dev environments are not supported - Update DEVGUIDE.md Node.js error resolution to match devcontainer approach Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Fixes broken documentation link from the Makefile’s Node.js version error by adding a #prerequisites anchor to CONTRIBUTING.md, and updates troubleshooting guidance to align with the project policy of supporting Dev Container / GitHub Codespaces environments (not generic local setups).
Changes:
- Added a new Prerequisites section in
CONTRIBUTING.mdto create the#prerequisitesanchor and direct developers to Dev Container / Codespaces. - Updated
DEVGUIDE.mdtroubleshooting for Node.js version errors to point users to Dev Container / Codespaces instead of manual Node installs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| DEVGUIDE.md | Updates Node.js version troubleshooting guidance to direct developers to Dev Container / Codespaces. |
| CONTRIBUTING.md | Adds a Prerequisites section (anchor target) describing the supported development environment setup. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| - **GitHub Codespaces** (recommended): Open this repository in a Codespace — everything is pre-configured automatically, including Go, Node.js 24, Docker, and the GitHub CLI. | ||
| - **VS Code Dev Container**: Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers), then open the repository folder and choose **Reopen in Container**. | ||
|
|
||
| The Dev Container installs all required dependencies and runs `make deps` automatically on creation. No manual setup is needed. |
There was a problem hiding this comment.
The Dev Container currently does not appear to run make deps on creation. .devcontainer/devcontainer.json only specifies a postCreateCommand that runs install-gh-aw.sh, and that script doesn’t invoke make deps. Please either update this text to match what actually happens, or update the Dev Container configuration so it really runs make deps automatically.
| The Dev Container installs all required dependencies and runs `make deps` automatically on creation. No manual setup is needed. | |
| The Dev Container installs all required tools and runtimes. After the container is created, run `make deps` inside it once to install all project dependencies. |
| > This project is designed to be developed inside a **Dev Container** or **GitHub Codespace**, which automatically configures all required tools and runtimes. | ||
|
|
There was a problem hiding this comment.
Product naming is inconsistent/incorrect here: “GitHub Codespace” should be “GitHub Codespaces” (the product) or “a Codespace” (an instance). Suggest rephrasing this sentence to use the correct name consistently with the bullet below (“GitHub Codespaces”).
|
|
||
| #### "Node.js version X is not supported" | ||
| **Solution**: Install Node.js 20+ (see [CONTRIBUTING.md](CONTRIBUTING.md#prerequisites)). | ||
| **Solution**: Use the Dev Container or GitHub Codespace — generic dev environments are not supported (see [CONTRIBUTING.md](CONTRIBUTING.md#prerequisites)). |
There was a problem hiding this comment.
Use the correct product name here as well: “GitHub Codespace” should be “GitHub Codespaces” (product) or “a Codespace” (instance). Align wording with CONTRIBUTING.md for consistency.
| **Solution**: Use the Dev Container or GitHub Codespace — generic dev environments are not supported (see [CONTRIBUTING.md](CONTRIBUTING.md#prerequisites)). | |
| **Solution**: Use the Dev Container or GitHub Codespaces — generic dev environments are not supported (see [CONTRIBUTING.md](CONTRIBUTING.md#prerequisites)). |
The Makefile's Node.js version error references
CONTRIBUTING.md#prerequisites, but that anchor didn't exist, resulting in a broken link. Additionally, the error suggested manually upgrading Node.js — which contradicts the project's policy that only Dev Container / Codespace environments are supported.Changes
CONTRIBUTING.md— Added## Prerequisitessection (creates the#prerequisitesanchor) that:make depsruns automatically on container creationDEVGUIDE.md— Updated the"Node.js version X is not supported"troubleshooting entry from "Install Node.js 20+" to point to the Dev Container approach📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.