/ CONTRIBUTING.md
CONTRIBUTING.md
 1  # Contributing to ShanClaw
 2  
 3  Thanks for your interest in contributing to ShanClaw!
 4  
 5  ## Getting Started
 6  
 7  ```bash
 8  git clone https://github.com/Kocoro-lab/ShanClaw.git
 9  cd ShanClaw
10  go build -o shan .
11  go test ./...
12  ```
13  
14  Requires **Go 1.25+**.
15  
16  ## How to Contribute
17  
18  1. **Bug reports** — open an issue with reproduction steps and expected vs actual behavior
19  2. **Feature requests** — open an issue describing the use case and proposed solution
20  3. **Pull requests** — fork the repo, create a branch, and submit a PR
21  
22  ## Pull Request Guidelines
23  
24  - Keep PRs focused on a single concern
25  - Include tests for new functionality
26  - Run `go test ./...` and `go vet ./...` before submitting
27  - Use conventional commit messages (`feat:`, `fix:`, `docs:`, `test:`, `refactor:`)
28  - Don't bump version numbers — maintainers handle releases
29  
30  ## Architecture
31  
32  See [CLAUDE.md](CLAUDE.md) for project structure, key conventions, and file paths.
33  
34  ## Questions?
35  
36  Open an issue or start a discussion on GitHub.