add note about member role and some formatting

matifali · matifali · commit 4bbc87f7179e · 2023-08-01T13:21:08.000Z
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -19,10 +19,10 @@ copying path '/nix/store/v2gvj8whv241nj4lzha3flq8pnllcmvv-ignore-5.2.0.tgz' from
 
 If [direnv](https://direnv.net/) is installed and the [hooks are configured](https://direnv.net/docs/hook.html) then the development environment can be _automatically instantiated_ by creating the following `.envrc`, thus removing the need to run `nix-shell` by hand!
 
-```
-$ cd ~/code/coder
-$ echo "use nix" >.envrc
-$ direnv allow
+```shell
+cd ~/code/coder
+echo "use nix" >.envrc
+direnv allow
 ```
 
 Now, whenever you enter the project folder, `direnv` will prepare the environment for you:
@@ -86,12 +86,14 @@ You can test your changes by creating a PR deployment. A PR deployment can be tr
 1. By commenting on the PR with `/deploy-pr`
 2. By running `./scripts/deploy-pr.sh`
 3. Available options
-    - `-s` or `--skip-build`, the image will not be built again, and the last image will be used.
-    - `-e EXPERIMENT1,EXPERIMENT2`  or `--experiments EXPERIMENT1,EXPERIMENT2`, will enable the specified experiments.
-    - `-n` or `--dry-run` will display the context without deployment. e.g., branch name and PR number, etc.
-    - `-y` or `--yes`, will skip the CLI confirmation (only valid for the `./scripts/deploy-pr.sh`)
+   - `-s` or `--skip-build`, the image will not be built again, and the last image will be used.
+   - `-e EXPERIMENT1,EXPERIMENT2` or `--experiments EXPERIMENT1,EXPERIMENT2`, will enable the specified experiments.
+   - `-n` or `--dry-run` will display the context without deployment. e.g., branch name and PR number, etc.
+   - `-y` or `--yes`, will skip the CLI confirmation (only valid for the `./scripts/deploy-pr.sh`)
+
+> Note: all flags can be used with both `./scripts/deploy-pr.sh` and `/deploy-pr` comment on the PR.
 
-> 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.
 
 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.
 
@@ -148,9 +150,9 @@ To create a full dump, run a fully fledged Coder deployment and use it to
 generate data in the database. Then shut down the deployment and take a snapshot
 of the database.
 
-```
-$ mkdir -p coderd/database/migrations/testdata/full_dumps/v0.12.2 && cd $_
-$ pg_dump "postgres://coder@localhost:..." -a --inserts >000069_dump_v0.12.2.up.sql
+```shell
+mkdir -p coderd/database/migrations/testdata/full_dumps/v0.12.2 && cd $_
+pg_dump "postgres://coder@localhost:..." -a --inserts >000069_dump_v0.12.2.up.sql
 ```
 
 Make sure sensitive data in the dump is desensitized, for instance names,
@@ -159,8 +161,8 @@ emails, OAuth tokens and other secrets. Then commit the dump to the project.
 To find out what the latest migration for a version of Coder is, use the
 following command:
 
-```
-$ git ls-files v0.12.2 -- coderd/database/migrations/*.up.sql
+```shell
+git ls-files v0.12.2 -- coderd/database/migrations/*.up.sql
 ```
 
 This helps in naming the dump (e.g. `000069` above).
