aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: ea4b1c7357c6dd8c1607227c052a5cbfcfb866b4 (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
# Contributing

In order to get started, you need to install [yarn](https://yarnpkg.com/),
[git](https://git-scm.com/) (yeah, it's actually a dependency) and a proper ruby
development environment (with bundler already installed). Then, you can simply
fetch dependencies like so:

```
$ yarn
$ bundle
```

After that, build Javascript files with:

```
$ yarn run webpack
```

And in another session start Jekyll with:

```
$ bundle exec jekyll serve
```

## Testing

Before submitting a Pull Request, make sure that tests are passing. This can be
checked by running:

```
$ bundle exec rubocop
$ bundle exec rake
```

## Deploying

This is already handled through a Github action, so don't worry about it.