From d966a7d50d03602e567850898bf260b00acdb948 Mon Sep 17 00:00:00 2001 From: Jeff Dickey <216188+jdx@users.noreply.github.com> Date: Thu, 2 Nov 2023 18:23:05 -0500 Subject: [PATCH] added dependency instructions --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca48ecdc82..2ae2d68637 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,9 @@ To use the container with VSCode, you'll need to install the [Remote - Container * [rust](https://www.rust-lang.org/) stable 1.66.1+ (it might be compatible with earlier, but I haven't tested that). As of this writing: 1.67.0 but GH actions will use the latest stable whenever it runs. * [just](https://github.com/casey/just) any version should do, but as of this writing I'm on 1.13.0 +* [md-magic](https://github.com/DavidWells/markdown-magic) +* [shfmt](https://github.com/mvdan/sh) +* [shellcheck](https://www.shellcheck.net/) (you'd think we'd use rtx to fetch these but frankly it's kind of a pain to dogfood rtx while testing it) @@ -73,6 +76,10 @@ You don't have to do this, but it makes things like `rtx activate` a lot easier * Run only E2E tests: `just test-e2e` * Run all tests: `just test` +## Releasing + +Run `just release -x [minor|patch]`. (minor if it is the first release in a month) + ## Linting * Lint codebase: `just lint`