Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (66 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

94 lines (66 loc) · 2.33 KB

Contributing to Ralph CLI

Thanks for your interest in contributing!

Development Setup

# Clone the repo
git clone https://github.com/yemyat/ralph-cli.git
cd ralph-cli

# Install dependencies
bun install

# Run in development mode
bun run dev

# Link globally for testing
bun link

Commit Convention

This project uses Conventional Commits. All commits must follow this format:

<type>: <description>

Types:

  • feat: - New feature (triggers minor version bump)
  • fix: - Bug fix (triggers patch version bump)
  • chore: - Maintenance, refactoring, dependencies

Breaking changes: Add ! after type (e.g., feat!:) or include BREAKING CHANGE: in the commit body. This triggers a major version bump.

Commits are enforced via commitlint + husky.

Git Workflow

feature branch → PR to dev → merge to dev
                                  ↓
                    (when ready to release)
                                  ↓
              dev → PR to main → merge to main
                                  ↓
                    semantic-release runs
                    (version bump + npm publish)

Branch Strategy

  • main - Production branch. Merges trigger releases.
  • dev - Development branch. All feature PRs target this branch.
  • Feature branches - Create from dev, name like feat/my-feature or fix/my-fix.

Pull Request Process

  1. Fork the repo and create your branch from dev
  2. Make your changes
  3. Ensure all checks pass: bun run lint && bun run typecheck
  4. Submit a PR to dev branch
  5. PRs are squash-merged to keep history clean

Creating a Release

Maintainers can trigger a release by:

  1. Go to Actions → Create Release PR
  2. Click Run workflow
  3. Merge the generated PR from dev → main

Code Style

  • TypeScript with strict mode
  • Use bun runtime
  • Minimal comments, prefer self-documenting code
  • Follow existing patterns in the codebase

Adding a New AI Agent

See AGENTS.md for instructions.

Releases

Releases are automated via semantic-release. When PRs are merged to main:

  • Version is auto-bumped based on commit types
  • CHANGELOG.md is updated
  • Package is published to npm
  • GitHub release is created

Questions?

Open an issue or start a discussion.