aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: ec76278da5a9ef5ae06ac100166cf06b1eab29d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
## Why?

Do you want to fix an error you have found? Do you have a suggestion to improve
this application? I am open for discussion and welcome any help!

## How?

[Like this](https://jo.mssola.com/en/contributing.html).

## Testing

Before doing anything at all make sure that your ruby version is as specified in
the `.ruby-version` file, and that you have also installed `bundler`. After
that, just run `bundle` to get all the gems as needed.

Then prepare the database:

```sh
$ bundle exec rake db:setup
```

And finally, in order to run unit tests, simply run:

```sh
$ bundle exec rails test
```

System tests can also be run quite simply:

```sh
$ bundle exec rails test:system
```

And finally, make sure that the code follows the proper style:

```sh
$ bundle exec rubocop
```