Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (26 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.01 KB

Contributing to cmuxlayer

Thanks for your interest in contributing to cmuxlayer!

Quick Setup

git clone https://github.com/EtanHey/cmuxlayer.git
cd cmuxlayer
bun install

Development Workflow

  1. Branch from main
  2. Write tests for your changes
  3. Run tests: bun test
  4. Open a PR against main

PR Process

  • All PRs are reviewed by CodeRabbit (automated)
  • PRs are squash-merged to keep history clean
  • Write a clear summary and test plan in your PR description

Vouching Model

First-time contributors need a vouch from an existing contributor. This keeps quality high while staying open to new people. Mention your voucher in your PR description.

AI Contributions

AI-assisted contributions are welcome. Include a Co-Authored-By trailer in your commit message to attribute the AI tool used:

Co-Authored-By: Claude <[email protected]>

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.