Contribution Guide

Contributions are always welcome, no matter how large or small! Here we summarize some general guidelines on how you can get involved in the Rolldown project.

Open development

All development happens directly on GitHub. Both core team members and external contributors (via forks) send pull requests which go through the same review process.

Outside of GitHub, we also use a Discord server for real-time discussions.

Reporting a bug

Please report bugs to GitHub only after you have previously searched for the issue and found no results. Be sure to be as descriptive as possible and to include all applicable labels.

The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example, or a usable code snippet. In the future, we will also provide a REPL that runs in the browser for easier reproductions.

Requesting new functionality

Before requesting new functionality, view open issues as your request may already exist. If it does not exist, submit an issue with the title prefixed with [request]. Be sure to be as descriptive as possible and to include all applicable labels.

Submitting a pull request

We accept pull requests for all bugs, fixes, improvements, and new features. Before submitting a pull request, be sure your build passes locally using the development workflow above.

For setting up the project's development environment, see Project Setup.

INFO

Please read the Etiquette chapter before submitting a pull request.

Branch organization

Submit all pull requests directly to the main branch. We only use separate branches for upcoming releases / breaking changes, otherwise, everything points to main.

Code that lands in main must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of main at any time.