Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (27 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.03 KB

Contributing to esq-cli

Thanks for your interest in contributing! Here's how to get started.

Development Setup

git clone https://github.com/enthus-appdev/esq-cli.git
cd esq-cli
go build ./cmd/esq      # Build the binary
go test -race ./...     # Run tests
golangci-lint run        # Lint

Requires Go 1.24+ and golangci-lint.

Making Changes

  1. Fork the repository and create a feature branch from main
  2. Write your code and add tests where appropriate
  3. Run golangci-lint run && go test -race ./... to ensure all checks pass
  4. Commit with a clear message describing the change
  5. Open a pull request against main

Code Style

  • Run goimports -w . before committing
  • Follow standard Go conventions

Reporting Bugs

Open a GitHub issue with:

  • Steps to reproduce
  • Expected vs actual behavior
  • CLI version (esq --version) and OS

License

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