use shell for codeblocks

matifali · matifali · commit 0050565d273b · 2023-08-01T13:25:48.000Z
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -4,11 +4,11 @@
 
 We recommend using the [Nix](https://nix.dev/) package manager as it makes any pain related to maintaining dependency versions [just disappear](https://twitter.com/mitchellh/status/1491102567296040961). Once nix [has been installed](https://nixos.org/download.html) the development environment can be _manually instantiated_ through the `nix-shell` command:
 
-```
-$ cd ~/code/coder
+```shell
+cd ~/code/coder
 
 # https://nix.dev/tutorials/declarative-and-reproducible-developer-environments
-$ nix-shell
+nix-shell
 
 ...
 copying path '/nix/store/3ms6cs5210n8vfb5a7jkdvzrzdagqzbp-iana-etc-20210225' from 'https://cache.nixos.org'...
@@ -27,8 +27,8 @@ direnv allow
 
 Now, whenever you enter the project folder, `direnv` will prepare the environment for you:
 
-```
-$ cd ~/code/coder
+```shell
+cd ~/code/coder
 
 # https://direnv.net/docs/hook.html
 direnv: loading ~/code/coder/.envrc
@@ -40,9 +40,9 @@ direnv: export +AR +AS +CC +CONFIG_SHELL +CXX +HOST_PATH +IN_NIX_SHELL +LD +NIX_
 
 Alternatively if you do not want to use nix then you'll need to install the need the following tools by hand:
 
-- Go 1.18+
+- Go 1.20+
   - on macOS, run `brew install go`
-- Node 14+
+- Node 18+
   - on macOS, run `brew install node`
 - GNU Make 4.0+
   - on macOS, run `brew install make`
@@ -53,15 +53,15 @@ Alternatively if you do not want to use nix then you'll need to install the need
 - [`pg_dump`](https://stackoverflow.com/a/49689589)
   - on macOS, run `brew install libpq zstd`
   - on Linux, install [`zstd`](https://github.com/horta/zstd.install)
-- [`pkg-config`]()
+- `pkg-config`
   - on macOS, run `brew install pkg-config`
-- [`pixman`]()
+- `pixman`
   - on macOS, run `brew install pixman`
-- [`cairo`]()
+- `cairo`
   - on macOS, run `brew install cairo`
-- [`pango`]()
+- `pango`
   - on macOS, run `brew install pango`
-- [`pandoc`]()
+- `pandoc`
   - on macOS, run `brew install pandocomatic`
 
 ### Development workflow
@@ -93,7 +93,7 @@ You can test your changes by creating a PR deployment. A PR deployment can be tr
 
 > Note: all flags can be used with both `./scripts/deploy-pr.sh` and `/deploy-pr` comment on the PR.
 
-> Note: You need to be a member or collaborator of the of [coder](github.com/coder) GitHub organization to be able to deploy a PR.
+> You need to be a member or collaborator of the of [coder](github.com/coder) GitHub organization to be able to deploy a PR.
 
 Once the deployment is finished, a unique link and credentials will be posted in the [#pr-deployments](https://codercom.slack.com/archives/C05DNE982E8) Slack channel.
 
@@ -105,12 +105,12 @@ Database migrations are managed with [`migrate`](https://github.com/golang-migra
 
 To add new migrations, use the following command:
 
-```
-$ ./coderd/database/migrations/create_fixture.sh my name
+```shell
+./coderd/database/migrations/create_fixture.sh my name
 /home/coder/src/coder/coderd/database/migrations/000070_my_name.up.sql
 /home/coder/src/coder/coderd/database/migrations/000070_my_name.down.sql
-Run "make gen" to generate models.
 ```
+Run "make gen" to generate models.
 
 Then write queries into the generated `.up.sql` and `.down.sql` files and commit
 them into the repository. The down script should make a best-effort to retain as
@@ -137,8 +137,8 @@ migration of multiple features or complex configurations.
 
 To add a new partial fixture, run the following command:
 
-```
-$ ./coderd/database/migrations/create_fixture.sh my fixture
+```shell
+./coderd/database/migrations/create_fixture.sh my fixture
 /home/coder/src/coder/coderd/database/migrations/testdata/fixtures/000070_my_fixture.up.sql
 ```
 
