Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (42 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 1.81 KB

Contributing to cwai

Thanks for your interest in contributing! This document covers everything you need to get started.

Development Setup

Prerequisites

Build & test

git clone https://github.com/nikmd1306/cwai.git
cd cwai

pre-commit install   # Set up pre-commit hooks
make build           # Build binary
make install         # Install to $GOPATH/bin
make clean           # Remove compiled binary
go test ./...        # Run all tests

How to Contribute

Reporting bugs

Open an issue with:

  • Steps to reproduce
  • Expected vs actual behavior
  • Go version, OS, cwai version

Suggesting features

Open a feature request describing the use case and proposed solution.

Submitting code

  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/my-feature
  3. Make your changes
  4. Run tests: go test ./...
  5. Commit your changes — and yes, we expect Conventional Commits. You know a tool that can help with that, right? cwai ;)
  6. Push and open a Pull Request

Pull Request Guidelines

  • Squash and merge only — every PR is squashed into a single commit on main. Don't worry about keeping a perfect commit history inside your PR branch; the PR title becomes the final commit message
  • Conventional Commits for the PR title (pro tip: make install && cwai — dogfood at its finest)
  • Add tests for new functionality
  • Ensure all existing tests pass
  • Keep PRs focused — one feature or fix per PR

Code Style

  • Format code with gofmt
  • Run go vet ./... before committing
  • Follow standard Go conventions and project structure