Skip to content

Latest commit

 

History

History
158 lines (98 loc) · 12.1 KB

CONTRIBUTING.md

File metadata and controls

158 lines (98 loc) · 12.1 KB
Raw

Contribute

Introduction

First, thank you for considering contributing to rollup! It's people like you that make the open source community such a great community! 😊

We welcome any type of contribution, not only code. You can help with

  • QA: file bug reports, the more details you can give the better (i.e. REPL-links or repos that demonstrate the specific issue)
  • Marketing: writing blog posts, howto's, printing stickers, ...
  • Community: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
  • Code: take a look at the open issues. Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
  • Money: we welcome financial contributions in full transparency on our open collective.

Your First Contribution

Working on your first Pull Request? You can learn how from this free course, How to Contribute to an Open Source Project on GitHub.

Setting up the Rust toolchain

Rollup now includes some Rust code. To compile it, you need to set up Rust nightly. If you haven't installed it yet, please first see https://www.rust-lang.org/tools/install to learn how to download Rustup and install Rust, then see https://rust-lang.github.io/rustup/concepts/channels.html to learn how to install Rust nightly.

Make sure you use the same nightly version as specified in the /rust/rust-toolchain.toml file. You should be able to install it with the following commands:

rustup toolchain install nightly-2023-10-05
rustup default nightly-2023-10-05

You should also install the wasm32-unknown-unknown target:

rustup target add wasm32-unknown-unknown

In the end, run

rustup update

If everything is set up correctly, npm run build should complete successfully. The first build will be rather slow, but subsequent builds will be much faster.

For local development and tests, it is even faster to run npm run build:quick, which does not perform a Rust production build, does not build WASM artefacts, and only builds the CommonJS version of Rollup. Note that with this build, a few tests will fail that rely on the other artefacts, see below.

Git configuration to enable symlinks

The unit tests in this projects make use of symlinks in the git project. On Windows, this may not work as expected without extra configuration. To configure git to create symlinks on windows, you need to enable the Windows "Developer Mode" setting, and also set the core.symlinks git feature using either of the following commands:

# Global setting
git config --global core.symlinks true

# Local setting
git config core.symlinks true

After applying this setting, you may need to reset your local branch to ensure the files get rewritten as symlinks. Note that this step is destructive and you will want to push any changes you have made prior to resetting your branch.

git reset --hard

How to run one test on your local machine

With npm run test you can run all tests together.

To save time for quick iterations, you can add solo:true to the _config.js file of any given test to run just this one test. To further speed up rebuilds, note that most tests just need the CommonJS build of Rollup.

For those tests, it is enough to run

npm run build:quick
npm run test:quick

Note that this does not run the browser tests and a few CLI tests will fail.

How to write tests

For any new feature or bug fix, sufficient test coverage is crucial.

Note that Rollup does not really have unit tests, only the external APIs are tested with the full Rollup build. While this may seem unusual, the tests are still very stable and fast. This provides us with the ability to perform major refactorings of the code base while ensuring full compatibility with the previous versions.

There are different test categories. Most of these tests are directory-based where you have a directory with a _config.js file that contains the test description and configuration and several code files. See /test/types.d.ts for a full list of available test configuration options for all directory based test types. By default, unless specified otherwise, the main.js file is the entry point for the test. To run the tests in an IDE, configure a "Mocha" compatible test runner that uses test/test.js as the entry point.

  • test/function: These tests bundle to CommonJS and then run the entry point provided by main.js. The assert function from node:assert is injected as a global variable, so you can make inline assertions in the code. You can also use the exports configuration key to make assertions on the exported values. These are very stable and meaningful tests and should be your first choice for new tests.
    • For regression testing when Rollup produces invalid code or crashes
    • For testing plugin interactions. To do so, import node:assert in your _config.js file and make assertions in your plugin hooks as needed.
    • For testing expected bundling errors, warnings and logs (use the error, generateError, warnings and logs configuration keys)
    • For asserting on the generated bundle object (use the bundle configuration key)
  • test/form: These tests bundle to all output formats and do not run the code. They compare the bundled code against an _expected directory that contains the output for all formats. If the format is not important, you can specify an _expected.js file instead, which will be compared against the output when bundling to ES module format.
    • For testing tree-shaking
    • For testing code that does not run on all supported NodeJS platforms
  • test/chunking-form: Similar to the form tests, these tests support multiple output files and assets. Instead of a single file, there is a directory for each output format.
  • test/cli: These tests run the Rollup CLI with a given configuration. They can compare the generated files against provided files and make assertions on stderr output. They can also optionally run the generated files.
  • test/watch: Test that watch mode works as expected. These tests are actually in the index.js file and only use the samples directory for input files.
  • test/browser: These tests bundle with the browser build of Rollup. They compare the output to an _expected directory and allow to make assertions on bundling errors. Note that you need to provide all input files via plugins.
  • test/sourcemaps: Tests to make assertions on the generated sourcemaps.
  • test/incremental: For testing the caching behaviour of Rollup. As these tests need to run Rollup more than once, it was not easily possible to implement them as directory-based tests.
  • test/file-hashes: Relevant for testing that different outputs have different file hashes. With the new hashing algorithm, these tests are not as important as they used to be and are kept mostly for historical reasons.
  • test/hooks: Do not add new tests here. These tests were the original tests for the plugin interface. For new tests, function tests are preferred as they are much easier to maintain.
  • test/misc: General tests that do not fit into the other categories.

Developing with the website

Running

npm run dev

will start the website locally in development mode via Vite. This will give you a live preview of the documentation. It will also verify that the documentation does not contain any dead links.

A special feature of the website is that the REPL at http://localhost:5173/repl/ is directly using the browser build of your local copy of Rollup created via Vite. It even supports full hot module replacement, which means that when you change anything within Rollup, the REPL will automatically rebundle the current code using your latest changes. This can come in very handy when working on a bug or tree-shaking improvement to allow extremely fast iterations.

Navigating the codebase

See the architecure documentation for an overview of the codebase and a high-level explanation of how Rollup works.

Submitting code

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.

Code review process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.

It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you? Does it resolve any known Github issues? Adding a line "resolves #" (e.g. "resolves #23") to the description of your pull request or of a specific commit will automatically close this issue once the pull request is merged.

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Questions

If you require technical assistance, Stackoverflow or Discord are usually the best places to start. You can also create an issue ( protip: do a quick search first to see if someone else didn't ask the same question before!).

Credits

Contributors

Thank you to all the people who have already contributed to rollup!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)