Contributing to @marimo-team/marimo-blocks

Thanks for your interest in contributing! Here's how you can help:

Development Setup

Fork and clone the repo
Install dependencies: pnpm install
Run tests: pnpm test
Start dev environment: pnpm dev

Development Process

Create a feature branch: git checkout -b feature-name
Make your changes
Run tests: pnpm test
Run type checks: pnpm typecheck
Run linting: pnpm lint
Commit your changes using conventional commits
Push to your fork and submit a pull request

Pull Request Guidelines

Include tests for any new functionality
Update documentation for API changes
Follow the existing code style
Keep PRs focused - one feature/fix per PR

Commit Messages

We use conventional commits. Format:

type(scope): description

[optional body]
[optional footer]

Types:

feat: New feature
fix: Bug fix
docs: Documentation only
style: Code style changes
refactor: Code changes that neither fixes a bug nor adds a feature
perf: Performance improvements
test: Adding or updating tests
chore: Changes to build process or auxiliary tools

Release Process

For maintainers only:

git checkout main
git pull
npx bumpp --no-git-check=false

Questions?

Open an issue or discussion if you have questions!