Skip to content

Latest commit

 

History

History
493 lines (340 loc) · 19.6 KB

CONTRIBUTING.md

File metadata and controls

493 lines (340 loc) · 19.6 KB

🚀 Contributing

We can use help in a bunch of areas and any help is greatly appreciated!

Table of Contents

Asking questions, making proposals

If you have any questions, proposals, or feedbacks, open a GitHub discussion. Make sure your comment adds value: don't post a comment just to get attention.

Our Discord server is open for help and more ad-hoc discussion. All activity on the Discord is still moderated and will be strictly enforced under the project's Code of Conduct.

Remember that we are doing this project on our own time. We are humans: we like support, and we expect kindness :)

Reporting bugs

Our GitHub issues serve as a place for submitting bugs. Make sure that the bugs is not reported yet and is not fixed in the main branch. You can test on the main branch, thanks to the playground.

Alternatively, you can use our official CodeSandbox template.

Getting Started

You can work on the project locally by cloning the repository and installing the required tools or use the pre-configured GitHub Codespaces and jump right into the code.

Local development

Building this project requires a stable Rust toolchain, which can be installed using rustup.

Clone the repository and navigate to the tools directory:

git clone https://github.com/biomejs/biome
cd biome

You can use cargo to run Biome CLI in development mode:

# This is like running "biome --help"
cargo biome-cli-dev --help

Install the required tools

We use Just to run scripts and tasks, to make our life easier.

You can install just using cargo:

cargo install just

But we highly recommend to install it using an OS package manager, so you won't need to prefix every command with cargo.

Once installed, run the following command to install the required tools:

just install-tools

This command will install:

  • cargo-binstall, to install binary extensions for cargo.
  • cargo-insta, a cargo extension to manage snapshot testing inside the repository.
  • taplo-cli, a small tool for formatting TOML files.
  • wasm-pack and wasm-tools for managing the WASM build of Biome.

You'll also need to have pnpm installed on your machine, and run pnpm install from the root of the repository. pnpm is needed to create changesets

And you're good to go hack with Biome and Rust! 🚀

GitHub Codespaces

Open in GitHub Codespaces

This Codespace comes pre-configured with the required tools and dependencies to work on the Biome project.

Note

A basic Codespace (32gb of disk space) might run out of disk space when building biome or running the full test suite. The pre-configured Codespace is therefor based on the premium image with 64gb of disk space.

Testing

You can either use cargo or just to run tests. For simplicity and running tests real quick, use cargo.

With cargo, you can run tests by using the test command:

# run tests
cargo test

# or use the shortcut
cargo t

If you run cargo t from the root, it will run all tests of the whole repository. If you're inside a crate folder, cargo will run tests of that crate:

cd crates/biome_cli

# it will run only the tests of the `biome_cli` crate
cargo t

You can run a single test with cargo by passing the test name after the test command:

cd crates/biome_js_formatter

cargo t quick_test

This will run the quick_test test inside the biome_js_formatter crate. You should see an output similar to this:

running 1 test
test quick_test::quick_test ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 224 filtered out; finished in 0.02s

You can also use just for running tests. With just, the scripts will use the same test runner we use in the CI.

just test

If you want to test the tests for a single crate:

just test-crate biome_cli

Rust has a concept of doctest. A doc test is a doc comment that runs some code. Usually, it looks something like this:

/// I am a doc test
/// ```
/// assert_eq!(true, true) // this is a doc test, and the assertion must pass
/// ```
fn some_fn() {

}

The code inside the code blocks is run during the testing phase.

To run only the doctest, you can run the command:

just test-doc

In some crates, we use snapshot testing. The majority of snapshot testing is done using insta. insta is already installed by the command just install-tools.

When a snapshot test fails, you can run:

  • cargo insta accept to accept all the changes and update all the snapshots;
  • cargo insta reject to reject all the changes;
  • cargo insta review to review snapshots singularly.

Debugging

Sometimes you want to debug something when running tests. Like console.log, in JavaScript, in Rust you can use the macro dbg!() to print something during debugging something. Then, pass the option --show-output to cargo:

fn some_function() -> &'static str {
    let some_variable = "some_variable";
    dbg!(&some_variable);
    some_variable
}
#[test]
fn test_some_function() {
    let result = some_function();
    assert_eq!(result, "some_variable")
}
cargo t test_some_function --show-output

Debug binaries

Creating a development binary is very useful in case you need to triage a reproduction, and you require more information like logging, trace logs, etc.

Additionally, you can use this binary when you need to debug issues related to LSP clients.

From the root of the repository, run the following command:

cargo build --bin biome

cargo will create a binary called biome in the target/debug/ directory.

If you're debugging a CLI reproduction, copy the biome binary inside the root of the reproduction, and change any script that uses the npm package to use the binary instead:

{
  "scripts": {
-    "lint": "biome lint",
+    "lint": "./biome lint"
  }
}

If you're debugging an LSP reproduction, make sure that the client allows to use custom binary, like VSCode and Zed. Provide an absolute URL to the binary that was emitted.

{
  "biome.lspBin": "/Users/john/www/biome/target/debug/biome"
}

Production binaries

Usually, the easiest way to create a production build is to use the --release flag, however Biome requires an environment variable called BIOME_VERSION to generate different code at compile time.

When you provide a BIOME_VERSION that is different from 0.0.0, the build will turn off all the nursery rules that are recommended. The value of BIOME_VERSION doesn't matter, as long as it's different from 0.0.0. This means that you'll have to provide a command similar to this:

BIOME_VERSION=0.0.1 cargo build --bin biome --release

Checks

When you finished your work, and you are ready to commit and open a PR, there are few other things you would need to run and check:

  • just f (alias for just format), formats Rust and TOML files.
  • just l (alias for just lint), run the linter for the whole project.
  • Code generation. The code generation of the repository is spread in the different parts of the code base. Sometimes is needed and sometime it isn't:
    • run just gen-analyzer when you're working on the linter;
    • run just gen-bindings in case you worked around the workspace.

Note

You can run just ready as well, although it's a command that runs the codegen of the whole repository, which will take some time

Crates development

Create new crates

If you happen to create a new crate inside the workspace, use the command just new-crate, e.g.:

cargo new crates/biome_new_crate --lib

Where biome_new_crate is going to be the name of the new crate. The --lib option tells cargo to create the crate as library, so you will probably see a src/lib.rs file.

Analyzers and lint rules

To know the technical details of how our analyzer works, how to create a rule and how to write tests, please check our internal page

Parser

To know the technical details of how our parser works and how to write test, please check our internal page

Formatter

To know the technical details of how our formatter works and how to write test, please check our internal page

Crate dependencies

Workspace dependencies are used, and many dependencies are defined in Cargo.toml in the root.

Internal crates are loaded with workspace = true for each crate. About dev-dependencies, we use path dependencies to avoid requiring the published version of these crates.

Node.js development

The npm module packages/@biomejs/biome contains Biome's Node.js API that supports different backends:

  • wasm-nodejs (WebAssembly)
  • backend-jsonrpc (Connection to the daemon)

For testing and developing, you need to build these packages, following the steps:

  1. install pnpm via corepack by running corepack enable;
  2. install wasm-pack globally;
  3. run pnpm --filter "@biomejs/backend-jsonrpc" build;
  4. run the pnpm --filter "@biomejs/js-api" build:wasm-dev and pnpm --filter "@biomejs/js-api" build commands;
  5. run pnpm i --filter "@biomejs/js-api" --frozen-lockfile to link the WebAssembly bindings and the JSON-RPC bindings

The tests are run against the compiled files, which means that you need to run the build script after you implemented features/bug fixes.

Translations

For more information on how to help with translation, please see the translation contribution guidelines for our docs.

Commit messages

Internally, the Biome team adheres as closely as possible to the conventional commit specification. The following this convention encourages commit best-practices and facilitates commit-powered features like change log generation.

The following commit prefixes are supported:

  • build:, a change that affects the build system or external dependencies
  • chore:, project housekeeping
  • ci:, a change that affects CI
  • docs:, a documentation update
  • feat:, a new feature
  • fix:, a bugfix
  • perf:, project performance
  • refactor:, refactor of the code without change in functionality
  • release:, release of a new version
  • revert:, revert a previous change
  • test:, a test update

Below are examples of well-formatted commits:

feat(compiler): implement parsing for new type of files
fix: fix nasty unhandled error
docs: fix link to website page
test(lint): add more cases to handle invalid rules

We are using action-semantic-pull-request to lint the titles of pull requests. If the 'Lint Pull Request Titles' workflow fails, please correct the title.

Creating pull requests

When creating a new pull request, it's preferable to use a conventional commit-formatted title, as this title will be used as the default commit message on the squashed commit after merging. See the dedicated section about conventional commit format.

Please use the template provided.

Changelog

This repository uses changesets to automate the releases of Biome's binaries, the JavaScript libraries and the creation of the CHANGELOG.md for each library.

Create a changeset

If the PR you're about to open is a bugfix/feature visible to users of the Biome toolchain or of the published Biome crates, you are encouraged to provide a changeset . To create a changeset, use the following command (don't create it manually):

just new-changeset

Note

The script uses pnpm under the hoods, so make sure to have ran pnpm i from the root of the repository before running this script.

The command will present a prompt where you need to choose the libraries involved by the PR, the type of change (major, minor or patch) for each library, and a description of the change. The description will be used as name of the file.

The command will create the changeset(s) in the .changeset folder. You're free to open the file, and add more information in it.

Choose the correct packages

In the vast majority of cases, you want to choose the @biomejs/biome package, which represents the main package.

The frontmatter of the changeset will look like this:

---
"@biomejs/biome": patch
---

Description here...

Choose the correct type of change

We are very strict about major changes in the @biomejs/biome package. To better understand type of your change for this package, please refer to our versioning page. Generally:

  • patch: any sort of change that fixes a bug.
  • minor: new features available to the users.
  • major: a change that breaks a user API.

Writing a changeset

The description of the changeset should follow the these guidelines:

  • Use the present tense, e.g. "Add new feature", "Fix edge case".
  • If you fix a bug, please add the link to the issue, e.g. "Fix edge case #4444".
  • Whenever applicable, add a code block to show your new changes. For example, for a new rule you might want to show an invalid case, for the formatter you might want to show how the new formatting changes, and so on.
  • End each sentence with fullstops.

If in doubt, take a look at existing or past changesets.

Documentation

If your PR requires some update on the website (new features, breaking changes, etc.), you should create a new PR once the previous PR is successfully merged. When adding new features, the documentation should be part of a new PR, which will be merged right before the release.

Versioning

We follow the specs suggested by the official documentation:

Odd minor versions are dedicated to pre-releases, e.g. *.5.* . Even minor versions are dedicated to official releases, e.g. *.6.*.

Releasing

When releasing a new version of a Biome, follow these steps:

  1. Add a changelog entry for every Pull Request that lacks one. You can filter merged PRs that don't update the changelog. Read our guidelines for editing the changelog.

  2. Update to the same version in all crates if you publish crates if applicable. (Cargo.toml and crates/**/Cargo.toml)

  3. Linter rules have a version metadata directly defined in their implementation. This field is set to next for newly created rules. This field must be updated to the new version.

  4. Merge the PR ci: release, and the release workflow will run. Once these workflows finish compiling the final artefact, they need to be approved manually by a member of the Core Contributors.

  5. Open a new PR in the website repository to update the website with the new version number: BIOME_VERSION=<version> pnpm run codegen:all. This will also copy the configuration schema in the right place.

Resources

We have several resources explaining about Biome. They will help you understand the project and codebase.

Current Members

Members are listed in alphabetical order. Members are free to use the full name, GitHub handle, or any other nickname they wish to be addressed. Members are free to disclose their pronouns.

Lead team

Core Contributors team

Maintainers team

Past Maintainers