Overview

How to contribute to the Elmo open source project.

Elmo is an open source project and we welcome contributions. Whether you're fixing a bug, adding a feature, or improving documentation, this guide will help you get started.

How to Contribute

  1. Fork the repository on GitHub
  2. Create a branch for your changes
  3. Set up your development environment — see Development Setup
  4. Make your changes and test them locally
  5. Add a changeset describing your changes:
    pnpm changeset
  6. Commit your changes along with the generated changeset file
  7. Open a pull request against the main branch

A maintainer will review your PR. Once merged, a maintainer will handle the release process.

What to Work On

  • Check the GitHub Issues for open tasks
  • Bug fixes are always welcome
  • Feature requests should be discussed in an issue before implementation
  • Documentation improvements are appreciated

Guidelines

  • Follow the existing code style — Biome handles linting and formatting
  • Write tests for new features when applicable
  • Keep PRs focused — one feature or fix per PR
  • Read the AI Contribution Policy if using AI tools

Was this page helpful?