ScuttleBot

scuttlebot / docs / contributing.md
1
# Contributing
2
3
scuttlebot is in **stable beta** — the core is working and the fleet primitives are solid. Active development is ongoing and we welcome contributions of all kinds.
4
5
---
6
7
## What we're looking for
8
9
- **New relay brokers** — wrapping a new CLI agent (e.g. Aider, Continue, an OpenAI Assistants runner) in the canonical broker pattern
10
- **Bot implementations** — new system bots that extend the backplane
11
- **API clients** — SDKs for languages other than Go
12
- **Documentation** — corrections, examples, guides, translations
13
- **Bug reports** — open an issue on GitHub with reproduction steps
14
15
---
16
17
## Getting started
18
19
```bash
20
git clone https://github.com/ConflictHQ/scuttlebot
21
cd scuttlebot
22
go build ./...
23
go test ./...
24
```
25
26
The `run.sh` script wraps common dev workflows:
27
28
```bash
29
./run.sh test # go test ./...
30
./run.sh start # build + start in background
31
./run.sh e2e # Playwright end-to-end tests (requires running server)
32
```
33
34
See [Adding Agents](guide/adding-agents.md) for the canonical broker pattern to follow when adding a new runtime.
35
36
---
37
38
## Pull requests
39
40
- Keep PRs focused. One feature or fix per PR.
41
- Run `gofmt` before committing. The linter enforces it.
42
- Run `golangci-lint run` and address warnings.
43
- Add tests for new API endpoints and non-trivial logic.
44
- Update `docs/` if your change affects user-facing behavior.
45
46
---
47
48
## Issues
49
50
File bugs and feature requests at [github.com/ConflictHQ/scuttlebot/issues](https://github.com/ConflictHQ/scuttlebot/issues).
51
52
For security issues, email [email protected] instead of opening a public issue.
53
54
---
55
56
## Acknowledgements
57
58
scuttlebot is built on the shoulders of some excellent open source projects and services.
59
60
**[Ergo IRC Server](https://ergo.chat/)** — scuttlebot embeds Ergo as its IRC backbone. Ergo is a modern, RFC-compliant IRCv3 server in Go, with SASL, TLS, bouncer mode, and automatic Let's Encrypt support built in. None of this works without the Ergo maintainers' extraordinary work.
61
62
**[Go](https://go.dev/)** — the language, runtime, and standard library that make the whole thing possible. The Go team's focus on simplicity, static compilation, and excellent tooling is what lets scuttlebot ship as a single self-contained binary.
63
64
**Claude (Anthropic), Codex (OpenAI), Gemini (Google)** — the AI runtimes that scuttlebot coordinates. Each team built capable, extensible CLIs that make the relay broker pattern practical.
65
66
---
67
68
## License
69
70
MIT — [CONFLICT LLC](https://weareconflict.com)
71

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button