Skip to main content

​
Let’s make Bruno better, together!

We’re excited that you’re interested in contributing to Bruno. This guide will help you get started with contributing to the project, whether you’re fixing bugs, adding features, or improving documentation.
Bruno is built using React and Electron. We use npm workspaces to manage our monorepo structure.

​
How You Can Contribute

There are many ways to contribute to Bruno:

Code Contributions

Fix bugs, add features, or improve performance

Documentation

Help improve our documentation and guides

Bug Reports

Report issues you encounter while using Bruno

Feature Requests

Suggest new features or improvements

​
Before You Start

1

Read the Documentation

Familiarize yourself with Bruno’s architecture and coding standards.
2

Set Up Your Environment

Follow our development setup guide to get Bruno running locally.
3

Find an Issue

Browse our GitHub issues to find something to work on, or create a new issue if you’ve found a bug or have a feature idea.
4

Start Contributing

Make your changes following our coding standards and submit a pull request.

​
Pull Request Guidelines

Please keep PRs small and focused on one thing. This makes them easier to review and merge.

​
Branch Naming Convention

Follow this format when creating branches: 
# For new features
git checkout -b feature/dark-mode
git checkout -b feature/graphql-support

​
PR Checklist

Before submitting your pull request:
  • Your code follows the coding standards
  • You’ve added tests for new functionality
  • All tests pass locally
  • You’ve updated documentation if needed
  • Your commits have clear, descriptive messages
  • The PR description clearly explains what changes were made and why

​
Testing Your Changes

Run tests before submitting your PR: 
# Run tests across all workspaces
npm test --workspaces --if-present

​
Code Review Process

Once you submit a PR:
  1. Automated Checks: GitHub Actions will run automated tests
  2. Code Review: Maintainers will review your code and provide feedback
  3. Iterations: You may need to make changes based on feedback
  4. Merge: Once approved, a maintainer will merge your PR
Be patient during the review process. Maintainers are volunteers and may take some time to review your contribution.

​
Getting Help

If you need help or have questions:

​
Code of Conduct

Be respectful and constructive in all interactions. We’re building a welcoming community where everyone can contribute.

​
Non-Code Contributions

Even if you can’t contribute code, you can still help! File bug reports, request features, share testimonials, or help other users in the community.

​
Share Your Testimonials

If Bruno has helped you at work or with your projects, please share your testimonials on GitHub Discussions.

​
Next Steps

Ready to start contributing? Head over to the Development Setup guide to get your environment configured.

Build docs developers (and LLMs) love

Get started for freeTalk to us