Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (35 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 1.31 KB
Raw

Contributing

Thanks for your interest in improving this project! This document explains how to set up a development environment and get your changes merged.

Development setup

git clone https://github.com/opao-max/LocalBox.git
cd LocalBox
go version   # requires Go 1.24+
go mod download

Workflow

  1. Fork the repository and create a branch from main: git checkout -b feat/short-description
  2. Make your change, keeping commits focused and using Conventional Commits: feat:, fix:, docs:, test:, refactor:, chore:.
  3. Before pushing, run the same checks as CI:
go vet ./...
go build ./...
go test ./...
gofmt -l .   # must print nothing
  1. Push your branch and open a Pull Request, filling in the PR template.

Code style

  • Run gofmt/goimports before every commit.
  • Exported identifiers must have doc comments.
  • Prefer table-driven tests; cover error paths, not just the happy path.
  • Keep public API changes backward compatible where possible; document breaking changes in the PR description and CHANGELOG.md.

Reporting bugs

Please use the Bug Report issue template and include a minimal reproduction.

License

By contributing, you agree that your contributions will be licensed under the repository's MIT License.