Skip to content

Commit

Permalink
chore: add codespace configuration (#5122)
Browse files Browse the repository at this point in the history
  • Loading branch information
Th3S4mur41 authored Feb 16, 2025
1 parent 1949e57 commit e9f679f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
16 changes: 16 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"image": "mcr.microsoft.com/devcontainers/universal:2",
"features": {
"ghcr.io/devcontainers/features/rust:1": {
"version": "latest",
"profile": "complete",
"targets": "aarch64-unknown-linux-gnu"
},
"ghcr.io/guiyomh/features/just:0": {
"version": "latest"
}
},
"hostRequirements": {
"storage": "64gb"
}
}
16 changes: 15 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ Alternatively, you can use our official [CodeSandbox template](https://codesandb

## Getting Started

You can [work on the project locally](#local-development) by cloning the repository and installing the required tools or [use the pre-configured GitHub Codespaces](#github-codespaces) and jump right into the code.

### Local development

Building this project requires a `stable` Rust toolchain, which can be installed using [rustup](https://www.rust-lang.org/tools/install).

Clone the repository and navigate to the `tools` directory:
Expand All @@ -74,7 +78,7 @@ You can use cargo to run Biome CLI in development mode:
cargo biome-cli-dev --help
```

## Install the required tools
#### Install the required tools

We use [Just](https://just.systems/man/en/) to run scripts and tasks, to make our life easier.

Expand Down Expand Up @@ -102,6 +106,16 @@ You'll also need to have `pnpm` installed on your machine, and run `pnpm install

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

### GitHub Codespaces

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?machine=premiumLinux&repo=671654508&ref=main&skip_quickstart=true)

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`.
Expand Down

0 comments on commit e9f679f

Please sign in to comment.