Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.13 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.13 KB
Raw

go-square

go-square is a Go library designed to provide utility functions for data square operations.

Installation

To use go-square as a dependency in your Go project, you can use go get:

go get github.com/celestiaorg/go-square

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

This repo attempts to conform to conventional commits so PR titles should ideally start with fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, or test: because this helps with semantic versioning and changelog generation. It is especially important to include an ! (e.g. feat!:) if the PR includes a breaking change.

Tools

  1. Install Go 1.21.5
  2. Install golangci-lint
  3. Fork this repo
  4. Make your changes
  5. Submit a pull request

Helpful Commands

# Display all available make commands
make help

# Run tests
make test

# Run linter
make lint

# Perform benchmarking
make bench