Contributing to bino

April 15, 2026 · View on GitHub

Thank you for your interest in contributing to bino! This document provides guidelines and information for contributors.

How to Contribute

Reporting Bugs

Use the issue tracker to report bugs.
Include your OS, Go version, and bino version (bino version).
Provide a minimal manifest that reproduces the issue when possible.

Suggesting Features

Open a discussion to propose new features before writing code.
Describe the use case and how the feature fits bino's design philosophy of declarative, YAML-driven report bundles.

Submitting Changes

Fork the repository and create a branch from main.
If you add code, add tests. Run the test suite:
```
go test -v -race ./...
```
Run the linter:
```
golangci-lint run ./...
```
Ensure your commit messages are clear and descriptive.
Open a pull request against main.

Development Setup

Prerequisites

Go 1.25 or later
CGO enabled (required for DuckDB)
Chrome headless shell (bino setup downloads it automatically)

Building

goreleaser build --snapshot --clean --single-target

Testing

go test -v -race ./...
go test -v -race -coverprofile=coverage.out ./...

Code Style

Follow standard Go conventions (gofmt, go vet).
Use golangci-lint with the project's configuration.
Keep functions focused and well-documented.

bino-cli is distributed under AGPLv3 and is also offered under separate commercial/SaaS licenses by the Project Owner. To make this dual-licensing model possible, all contributors must sign a Contributor License Agreement (CLA) before their pull request can be merged.

Individuals: sign the Individual CLA (ICLA). The CLA Assistant bot will prompt you automatically on your first pull request.
Companies: an authorized officer must also sign the Corporate CLA (CCLA) and list authorized contributors in Schedule A.

Under the CLA, you retain copyright in your Contributions and grant the Project Owner the rights needed to distribute your Contributions under AGPLv3 and under commercial terms. See CLA.md for the full grant summary.

License

bino-cli is licensed under the GNU Affero General Public License v3.0 (AGPLv3) — see the LICENCE file.