Skip to content

docs: update merge strategy and CI table in CONTRIBUTING #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kolkov merged 1 commit into from
Jul 12, 2026
Merged

docs: update merge strategy and CI table in CONTRIBUTING #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Born is a modern ML framework for Go, and we welcome contributions of all kinds

| Tool | Version | Purpose |
|------|---------|---------|
| **Go** | 1.25+ | [Download](https://go.dev/dl/) |
| **Go** | 1.26+ | [Download](https://go.dev/dl/) |
| **Git** | Latest | Version control |
| **golangci-lint** | Latest | [Install](https://golangci-lint.run/usage/install/) |
| **Make** | Any | Build automation (optional) |
Expand Down Expand Up @@ -414,20 +414,32 @@ All PRs run through CI:

| Check | Description |
|-------|-------------|
| **Unit Tests** | Ubuntu, macOS, Windows (Go 1.25) |
| **Unit Tests** | Ubuntu, macOS, Windows (Go 1.26) |
| **Lint** | golangci-lint with project config |
| **Code Formatting** | gofmt verification |
| **Build Examples** | Compile all examples |
| **Build Tools** | Compile CLI tools |
| **Build WASM** | `GOOS=js GOARCH=wasm go build ./...` |
| **Benchmarks** | Run performance benchmarks |
| **Codecov** | Coverage reporting |

### Merge Strategy

We choose the merge method based on commit history:

| History | Merge method | Rationale |
|---------|-------------|-----------|
| Clean semantic commits (each carries a distinct change) | `--merge` | Preserves author's commit structure |
| Mixed/WIP commits (fixups, review changes) | `--squash` | Produces a clean single commit |

If you have a preference, note it in the PR description (e.g., "please merge, not squash") and we'll respect it.

### Review Process

1. CI runs automatically on PR creation
2. Maintainer reviews code
3. Feedback addressed (if any)
4. Approval and merge (squash merge preferred)
4. Approval and merge

---

Expand Down
Loading