Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
144 lines (99 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

144 lines (99 loc) · 2.74 KB
Raw

Contributing

Getting Started

Fork and clone the repository:

git clone https://github.com/your-username/lib.git
cd lib
just setup --dev        # Installs Claude CLI and Claudevoyant plugin

Claudevoyant Plugin

This template uses the Claudevoyant plugin for slash commands like /plan, /commit, /upgrade, etc. The plugin is automatically installed when you run just setup --dev.

If you need to reinstall the plugin manually, first add the marketplace:

claude plugin marketplace add cloudvoyant/claudevoyant

Then install the plugin:

claude plugin install claudevoyant

For local plugin development:

claude plugin marketplace add ../claudevoyant
claude plugin install claudevoyant

Development Workflow

Make your changes:

git checkout -b feature/my-feature
# Make changes
just build
just test

Commit using conventional commit format:

git commit -m "feat: add new feature"
git commit -m "fix: resolve bug"
git commit -m "docs: update readme"

Push and create a pull request:

git push origin feature/my-feature

Commit Message Format

Use conventional commits for automatic versioning:

  • feat: - New feature (minor version bump)
  • fix: - Bug fix (patch version bump)
  • docs: - Documentation changes
  • style: - Code style changes (formatting, etc.)
  • refactor: - Code refactoring
  • test: - Adding or updating tests
  • chore: - Maintenance tasks

Breaking changes:

git commit -m "feat!: breaking change description"

or:

git commit -m "feat: description

BREAKING CHANGE: explanation of breaking change"

Code Style

  • Follow .editorconfig settings
  • LF line endings
  • Insert final newline
  • Trim trailing whitespace

Testing

Run tests before submitting:

just test

Ensure CI passes on your pull request.

Documentation

Update documentation when:

  • Adding new features
  • Changing behavior
  • Adding new commands

Documentation files:

  • README.md - Quick start and overview
  • docs/architecture.md - Design, architecture, and implementation

Follow the documentation style guide:

  • Be concise and scannable
  • Use backticks for files, commands, and code
  • Avoid excessive bold formatting

Pull Request Process

  1. Create a feature branch
  2. Make your changes
  3. Run just build && just test
  4. Commit with conventional commit messages
  5. Push and create PR
  6. Wait for CI to pass
  7. Address review feedback
  8. Maintainer merges when approved

Release Process

Releases are automated:

  1. PR merged to main
  2. release.yml workflow runs semantic-release
  3. Version tag created based on commits
  4. publish.yml workflow publishes package
  5. GitHub release created with notes

Manual releases are not necessary.