Skip to content

fix: add Prerequisites section to CONTRIBUTING.md, point to Dev Container #20681

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

Merged
pelikhan merged 2 commits into from
Mar 12, 2026
Merged

fix: add Prerequisites section to CONTRIBUTING.md, point to Dev Container #20681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd8387e
Initial plan
Copilot Mar 12, 2026
c3b676b
fix: add Prerequisites section to CONTRIBUTING.md with devcontainer g…
Copilot Mar 12, 2026
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
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Comment on lines +14 to +15
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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”).

Copilot uses AI. Check for mistakes.
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.
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.

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:
Expand Down
2 changes: 1 addition & 1 deletion DEVGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)).
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
**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)).

Copilot uses AI. Check for mistakes.

#### Test failures after `git pull`
**Solution**: Rebuild dependencies and binary:
Expand Down
Loading