Skip to content

Commit c672a5d

Browse files
Copilotstrawgate
andauthored
docs: add Go prerequisite to developing quick-start (#545)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com> Co-authored-by: Bill Easton <bill.easton@elastic.co>
1 parent c6503d3 commit c672a5d

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

DEVELOPING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@
1010

1111
Internal-only workflows (e.g., `upgrade-check.md`, `workflow-patrol.md`, `ci.yml`, `release.yml`) also live in `.github/workflows/`. Published workflows use the `gh-aw-` prefix; internal-only ones omit it. See [gh-agent-workflows/DEVELOPING.md](gh-agent-workflows/DEVELOPING.md) for the full architecture.
1212

13+
## Prerequisites
14+
15+
- [Go](https://go.dev/dl/) — required by `make setup` to build the `gh-aw` compiler
16+
- [GitHub CLI (`gh`)](https://cli.github.com/) — installed automatically by `make setup` on Linux, but must be pre-installed on macOS
17+
18+
Verify with:
19+
20+
```bash
21+
go version
22+
```
23+
1324
## Quick Start
1425

1526
```bash

docs/developing.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@
1010

1111
Internal-only workflows (e.g., `upgrade-check.md`, `workflow-patrol.md`, `ci.yml`, `release.yml`) also live in `.github/workflows/`. Published workflows use the `gh-aw-` prefix; internal-only ones omit it.
1212

13+
## Prerequisites
14+
15+
- [Go](https://go.dev/dl/) — required by `make setup` to build the `gh-aw` compiler
16+
- [GitHub CLI (`gh`)](https://cli.github.com/) — installed automatically by `make setup` on Linux, but must be pre-installed on macOS
17+
18+
Verify with:
19+
20+
```bash
21+
go version
22+
```
23+
1324
## Quick start
1425

1526
```bash

0 commit comments

Comments
 (0)