Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add codespace configuration #5122

Merged
merged 5 commits into from
Feb 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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