lerko
c2bfa5ad82
- README/CONTRIBUTING quick start: add UPTOP_ADMIN_KEY so SSH works on fresh DB, fix single-file go run path that doesn't compile - apply --dry-run: assign placeholder IDs for new alerts and groups so resolveAlertID succeeds when monitors reference not-yet-created alerts - deploy/*.yml: switch user-facing compose files from broken build context to image: lerkolabs/uptop:latest, fix dev context to ..
24 lines
485 B
Markdown
24 lines
485 B
Markdown
# Contributing
|
|
|
|
## Development
|
|
|
|
```sh
|
|
go run ./cmd/uptop -demo # starts with sample data
|
|
ssh -p 23234 localhost # connect to TUI
|
|
```
|
|
|
|
## Tests
|
|
|
|
```sh
|
|
go test ./... # unit tests
|
|
go test -race ./... # race detector
|
|
golangci-lint run ./... # linting
|
|
```
|
|
|
|
## Pull Requests
|
|
|
|
- Branch from `main`, PR back to `main`
|
|
- Conventional Commits for messages (`feat:`, `fix:`, `chore:`)
|
|
- Tests must pass, linter must be clean
|
|
- One logical change per PR
|