Skip to content

Commit d5c4486

Browse files
committed
fix ordering in contributing doc
1 parent 749bfc2 commit d5c4486

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
>[!NOTE]
33
> Building from source is only required if you'd like to contribute. The recommended way to use Sourcebot is to use the [pre-built docker image](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot).
44
5-
1. Install <a href="https://go.dev/doc/install"><img src="https://go.dev/favicon.ico" width="16" height="16"> go</a>, and <a href="https://nodejs.org/"><img src="https://nodejs.org/favicon.ico" width="16" height="16"> NodeJS</a>. Note that a NodeJS version of at least `21.1.0` is required.
5+
1. Install <a href="https://go.dev/doc/install"><img src="https://go.dev/favicon.ico" width="16" height="16"> go</a>, <a href="https://docs.docker.com/get-started/get-docker/"><img src="https://www.docker.com/favicon.ico" width="16" height="16"> docker</a>, and <a href="https://nodejs.org/"><img src="https://nodejs.org/favicon.ico" width="16" height="16"> NodeJS</a>. Note that a NodeJS version of at least `21.1.0` is required.
66

77
2. Install [ctags](https://github.com/universal-ctags/ctags) (required by zoekt)
88
```sh
@@ -13,28 +13,32 @@
1313
snap install universal-ctags
1414
```
1515

16-
3. Install <a href="https://docs.docker.com/get-started/get-docker/"><img src="https://www.docker.com/favicon.ico" width="16" height="16"> docker</a> and start the development Docker containers for PostgreSQL and Redis.
17-
16+
3. Install `yarn`:
1817
```sh
19-
docker compose -f docker-compose-dev.yml up -d
18+
npm install --global yarn
2019
```
2120

22-
4. Clone the repository with submodules:
21+
3. Clone the repository with submodules:
2322
```sh
2423
git clone --recurse-submodules https://github.com/sourcebot-dev/sourcebot.git
2524
```
26-
27-
5. Run `make` to build zoekt and install dependencies:
25+
4. Run `make` to build zoekt and install dependencies:
2826
```sh
2927
cd sourcebot
3028
make
3129
```
3230

3331
The zoekt binaries and web dependencies are placed into `bin` and `node_modules` respectively.
3432

33+
5. Start the development Docker containers for PostgreSQL and Redis.
34+
35+
```sh
36+
docker compose -f docker-compose-dev.yml up -d
37+
```
38+
3539
6. Create a copy of `.env.development` and name it `.env.development.local`. Update the required environment variables.
3640

37-
7. If you're using a declerative configuration file (the default behavior if you didn't enable auth), create a configuration file and update the `CONFIG_PATH` environment variable in your `.env.development.local` file.
41+
7. If you're using a declerative configuration file, create a configuration file and update the `CONFIG_PATH` environment variable in your `.env.development.local` file.
3842
3943
8. Start Sourcebot with the command:
4044
```sh

0 commit comments

Comments
 (0)