ScuttleBot
|
1
|
# Contributing to scuttlebot |
|
2
|
|
|
3
|
Thanks for your interest in contributing! |
|
4
|
|
|
5
|
## Development setup |
|
6
|
|
|
7
|
```bash |
|
8
|
git clone https://github.com/ConflictHQ/scuttlebot |
|
9
|
cd scuttlebot |
|
10
|
go mod download |
|
11
|
``` |
|
12
|
|
|
13
|
See [`bootstrap.md`](../bootstrap.md) for full setup including the Ergo IRC server. |
|
14
|
|
|
15
|
## Running tests |
|
16
|
|
|
17
|
```bash |
|
18
|
go test ./... |
|
19
|
``` |
|
20
|
|
|
21
|
## Code style |
|
22
|
|
|
23
|
We use `gofmt` (enforced) and `golangci-lint`. |
|
24
|
|
|
25
|
```bash |
|
26
|
gofmt -w . |
|
27
|
golangci-lint run |
|
28
|
``` |
|
29
|
|
|
30
|
## Pull requests |
|
31
|
|
|
32
|
1. Fork the repo and create a branch from `main` |
|
33
|
2. Add tests for new behaviour |
|
34
|
3. Ensure CI passes |
|
35
|
4. Open a PR with a clear description of the change |
|
36
|
|
|
37
|
## Commit messages |
|
38
|
|
|
39
|
Use the imperative mood: `add X`, `fix Y`, `update Z`. Keep the first line under 72 characters. |
|
40
|
|