Skip to content

Commit c9d0c5e

Browse files
committed
docs: add development section to README
1 parent 6871b87 commit c9d0c5e

2 files changed

Lines changed: 23 additions & 2 deletions

File tree

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ BINARY := stacktower
44

55
all: check build
66

7-
check: fmt lint test
7+
check: fmt lint test vuln
88

99
fmt:
1010
@gofmt -s -w .
@@ -65,7 +65,7 @@ clean:
6565

6666
help:
6767
@echo "make - Run checks and build"
68-
@echo "make check - Format, lint, test"
68+
@echo "make check - Format, lint, test, vulncheck (same as CI)"
6969
@echo "make fmt - Format code"
7070
@echo "make lint - Run golangci-lint"
7171
@echo "make test - Run tests"

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,27 @@ func (p *MyLockParser) Parse(path string, opts deps.Options) (*deps.ManifestResu
427427

428428
The `deps.Registry` handles concurrent fetching with configurable depth/node limits and metadata enrichment automatically.
429429

430+
## Development
431+
432+
```bash
433+
make install-tools # Install required tools (golangci-lint, goimports, govulncheck)
434+
make check # Run all CI checks locally (fmt, lint, test, vuln)
435+
make build # Build binary to bin/stacktower
436+
```
437+
438+
| Command | Description |
439+
|---------|-------------|
440+
| `make check` | Format, lint, test, vulncheck (same as CI) |
441+
| `make fmt` | Format code with gofmt and goimports |
442+
| `make lint` | Run golangci-lint |
443+
| `make test` | Run tests with race detector |
444+
| `make cover` | Run tests with coverage report |
445+
| `make vuln` | Check for known vulnerabilities |
446+
| `make e2e` | Run end-to-end tests |
447+
| `make snapshot` | Build release locally (no publish) |
448+
449+
Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/).
450+
430451
## Learn More
431452

432453
- 📖 **[stacktower.io](https://www.stacktower.io)** — Interactive examples and the full story behind tower visualizations

0 commit comments

Comments
 (0)