Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (31 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.8 KB
Raw

Contributing

Thanks for your interest in contributing! This guide covers how to get from a clone to a merged pull request.

By participating, you agree to abide by our Code of Conduct. All documentation, code, comments, and commit messages in this repository are written in English.

Getting started

This project uses Bun as its runtime and package manager.

git clone https://github.com/pleaseai/cli-toolkit.git
cd cli-toolkit
bun install         # install dependencies

Worktree setup (tools, dependencies, local files) is automated via orca.yaml.

Development workflow

  1. Create a branch from main (e.g. feat/short-description or fix/issue-123).
  2. Make focused changes — keep each pull request to one logical change.
  3. Run the checks below and make sure they pass.
  4. Open a pull request and fill out the template.
bun run lint        # lint and format
bun test            # run the test suite
bun run type-check  # type-check
bun run build       # ensure it builds

Commit messages

We follow Conventional Commits: type(scope): subject, where type is one of feat, fix, docs, refactor, test, chore, etc. Breaking changes include a BREAKING CHANGE: footer. Versioning and the changelog are generated automatically from these messages, so accurate types matter.

Pull requests

  • Reference the issue your PR addresses (e.g. Closes #123).
  • Use a Conventional-Commit-style PR title — it becomes the squash-merge commit.
  • Make sure CI is green before requesting review.

Reporting bugs and requesting features

Open an issue using the bug report or feature request template. For security vulnerabilities, do not open a public issue — follow SECURITY.md.