Skip to content

Commit 126d2c1

Browse files
docs(CONTRIBUTING): simplified setup guide
1 parent 3a27675 commit 126d2c1

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

CONTRIBUTING.md

+8-14
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The `development`-branch is the primary branch for ongoing work, while the `main
88

99
We follow the Conventional Commits specification. Please use the structure explained in the [quick summary](https://www.conventionalcommits.org/en/v1.0.0/#summary) of the specification. Commit messages are written in the imperative present tense, describing what the commit does, as if giving a command or instruction. Examples are listed below.
1010

11-
```
11+
```text
1212
feat(web): add redirect instead of console.log (due to linting)
1313
fix(ci): avoid running deploy job on PR pushes
1414
chore(deps-dev): bump eslint-plugin-unused-imports from 3.1.0 to 3.2.0 in /cms
@@ -21,28 +21,22 @@ The setup for this project consists of three main parts: the website (web), the
2121
### Prerequisites
2222

2323
- Docker and Docker Compose
24-
- Node.js and npm
24+
- Node.js and NPM
2525
- MySQL 8
26-
- Node version manager like NVM
26+
- Node version manager NVM
2727
- Make
2828

2929
### Getting Started
3030

31-
```
31+
```sh
3232
git checkout development
3333

3434
# if you have node version manager installed otherwise ensure you have the correct node version, specified in .nvmrc
3535
nvm use
3636

37-
# installs dependencies, creates .env files, starts containers for local development
38-
make dev
39-
40-
# if you need to rebuild containers
41-
make build dev
42-
43-
# with logs
44-
make build dev logs
45-
46-
# for further commands, see makefile
37+
# see makefile for available commands
4738
make
39+
40+
# i.e install dependencies, setup .env files, start containers for local development and show logs
41+
make dev logs
4842
```

0 commit comments

Comments
 (0)