Skip to content

Commit c2f465c

Browse files
committed
feat: add .openboot.yml for one-command dev setup
1 parent 18eccb4 commit c2f465c

2 files changed

Lines changed: 27 additions & 4 deletions

File tree

.openboot.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
version: "1.0"
2+
3+
brew:
4+
packages:
5+
- go
6+
- git
7+
- gh
8+
- upx
9+
10+
init:
11+
- go mod download
12+
- make build
13+
14+
verify:
15+
- go version
16+
- git --version
17+
- gh --version
18+
- ./openboot version

CONTRIBUTING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,9 @@ Contributions are welcome. @fullstackjam maintains the project and reviews all P
77
```bash
88
git clone https://github.com/YOUR_USERNAME/openboot.git
99
cd openboot
10+
openboot init # installs Go, upx, gh, tart — then builds
1011
git checkout -b fix-something
1112

12-
# Build
13-
go build -o openboot ./cmd/openboot
14-
./openboot --dry-run
15-
1613
# Test
1714
make test-unit
1815

@@ -21,6 +18,8 @@ git commit -m "fix: the thing"
2118
git push origin fix-something
2219
```
2320

21+
> Don't have OpenBoot yet? `curl -fsSL openboot.dev/install.sh | bash`
22+
2423
Then open a PR — use the template, it's short.
2524

2625
## Good First Contributions
@@ -39,6 +38,12 @@ make test-integration # Slower
3938
make test-all # Everything + coverage
4039
```
4140

41+
VM-based E2E tests require [Tart](https://github.com/cirruslabs/tart) (macOS virtualization). Install it only if you need to run `make test-vm-*`:
42+
43+
```bash
44+
brew install cirruslabs/cli/tart
45+
```
46+
4247
## Code Expectations
4348

4449
- Standard Go style (`go vet` must pass)

0 commit comments

Comments
 (0)