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
- Fork the repository on GitHub
- Create a branch for your changes
- Set up your development environment — see Development Setup
- Make your changes and test them locally
- Add a changeset describing your changes:
pnpm changeset - Commit your changes along with the generated changeset file
- Open a pull request against the
mainbranch
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
Quick Links
Development Setup
Prerequisites, installation, and running the dev servers.
Commands Reference
All the scripts and commands you'll need.
Architecture
Project structure and how the pieces fit together.
AI Policy
Guidelines for using AI tools when contributing.
Was this page helpful?