From fd8387eba8da0c806eae872df0612f9cfb30ce31 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 12 Mar 2026 13:57:47 +0000 Subject: [PATCH 1/2] Initial plan From c3b676b12476a8f21ada05236c7f5f6a4a27908e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 12 Mar 2026 14:04:38 +0000 Subject: [PATCH 2/2] fix: add Prerequisites section to CONTRIBUTING.md with devcontainer guidance (#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> --- CONTRIBUTING.md | 14 ++++++++++++++ DEVGUIDE.md | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 414e7396abf..64db35fd85e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,20 @@ Thank you for your interest in contributing to GitHub Agentic Workflows! We welc This document deals with the contribution process for non-Core team members. +## Prerequisites + +> ⚠️ **Generic dev environments (e.g. manually installed Node.js, Go, or other tools) are not supported.** +> This project is designed to be developed inside a **Dev Container** or **GitHub Codespace**, which automatically configures all required tools and runtimes. + +The recommended way to set up a development environment is to use the provided [Dev Container](.devcontainer/devcontainer.json): + +- **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. + +If you encounter errors about Node.js or Go versions when running `make deps` or other build commands, this is a sign that you are not using the Dev Container. Please switch to a Dev Container or Codespace environment. + ## 🤖 How Development Works GitHub Agentic Workflows is developed by a core team using agentic development — primarily GitHub Copilot coding agent and local coding agents. This means: diff --git a/DEVGUIDE.md b/DEVGUIDE.md index 2e9cd31545a..6c6d94c57f9 100644 --- a/DEVGUIDE.md +++ b/DEVGUIDE.md @@ -259,7 +259,7 @@ The project has several test targets optimized for different scenarios: **Solution**: Run `make deps-dev` to install development dependencies. #### "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)). #### Test failures after `git pull` **Solution**: Rebuild dependencies and binary: