File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Contributing to Chief
2+
3+ Thanks for your interest in contributing to Chief! Here's how to get started.
4+
5+ ## Prerequisites
6+
7+ - [ Go 1.24+] ( https://go.dev/dl/ )
8+ - [ Claude Code CLI] ( https://docs.anthropic.com/en/docs/claude-code ) (for end-to-end testing)
9+ - [ golangci-lint] ( https://golangci-lint.run/welcome/install-local/ ) (optional, for linting)
10+
11+ ## Getting Started
12+
13+ ``` bash
14+ git clone https://github.com/minicodemonkey/chief.git
15+ cd chief
16+ make build
17+ ```
18+
19+ ## Development Workflow
20+
21+ ``` bash
22+ make build # Build the binary to ./bin/chief
23+ make test # Run all tests
24+ make lint # Run linters
25+ make fmt # Format code
26+ make vet # Run go vet
27+ make run # Build and run the TUI
28+ ```
29+
30+ ## Submitting Changes
31+
32+ 1 . Fork the repository
33+ 2 . Create a feature branch (` git checkout -b my-feature ` )
34+ 3 . Make your changes
35+ 4 . Run ` make test ` and ` make lint ` to verify
36+ 5 . Commit using [ conventional commits] ( https://www.conventionalcommits.org/ ) (e.g. ` feat: ` , ` fix: ` , ` docs: ` )
37+ 6 . Open a pull request against ` main `
38+
39+ ## Reporting Bugs
40+
41+ Open an issue on [ GitHub Issues] ( https://github.com/minicodemonkey/chief/issues ) with:
42+
43+ - Steps to reproduce
44+ - Expected vs actual behavior
45+ - Chief version (` chief --version ` or ` git describe --tags ` )
46+
47+ ## License
48+
49+ By contributing, you agree that your contributions will be licensed under the [ MIT License] ( README.md#license ) .
You can’t perform that action at this time.
0 commit comments