Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 1.4 KB

Contributing

Thanks for your interest in ClawTerm! This project is open source under the MIT License — anyone can fork, modify, and use it. Contributions to this repository go through PR review by the maintainer.

Setup

git clone https://github.com/clawterm/clawterm.git
cd clawterm
npm install
npm run tauri dev

Requires Rust (stable) and Node.js 18+. macOS needs Xcode CLI tools (xcode-select --install).

Workflow

  1. Branch off main — one feature or fix per PR
  2. Run npm run preflight before pushing (lint, format, test, typecheck)
  3. Open a PR using the pull request template
  4. A maintainer will review — all PRs require approval before merge

Reporting bugs

Use the bug report template. Include your ClawTerm version, OS, and steps to reproduce.

Suggesting features

Use the feature request template. Describe the problem you're solving and your proposed approach.

Review process

All code changes go through PR review. The CODEOWNERS file assigns reviewers automatically. CI must pass (lint, format, test, typecheck) before a PR can be merged.

License

By contributing, you agree your work is licensed under the MIT License.