Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

81 lines (55 loc) · 1.56 KB
Raw

Contributing to Adroit

Prerequisites

Make sure to have these tools installed:

Other tools that are optional but useful:

Setup

Once you've installed all prerequisites, clone this repo, e.g. with GitHub CLI:

gh repo clone adroit-lang/adroit

Then open a terminal in your clone of it; for instance, if you cloned it via the terminal, run this command:

cd adroit

Rust

Run this command to build and test the main Rust codebase:

cargo test

JavaScript

We use Bun for our website and for our VS Code extension. To work with the JavaScript packages in this repository, first install all dependencies from npm:

bun install

Website

To develop the website locally, run this command:

bun run --filter=@adroit-lang/website watch

Then in a separate terminal:

bun run --filter=@adroit-lang/website serve

VS Code

On Linux or macOS, run these commands to build the VS Code extension (on Windows, the binary filename will end with .exe):

cargo build --release
mkdir packages/adroit-vscode/bin
cp target/release/adroit packages/adroit-vscode/bin/adroit
bun run --filter=adroit-vscode build

Then in the VS Code Explorer, right-click on the packages/adroit-vscode/adroit-vscode-*.vsix file that has been created, and click Install Extension VSIX.