blob: 0914fdc8b0d70df7570628891cb13a3f62b2bce1 (
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
39
40
41
42
43
44
|
#+STARTUP:showall
* Contributing
** Running tests
There are a couple of dependencies in order to run tests. These dependencies
will be picked up directly by the =vendor= make task. You can run it by
performing:
#+BEGIN_SRC bash
$ make vendor
#+END_SRC
The =vendor= task is already called by other tasks such as =lint=. Thus, if you
just want to run everything, just execute:
#+BEGIN_SRC bash
$ make
#+END_SRC
This will fetch the dependencies for you and run the style checkers and the
tests, among other things. See the sections below to read more about them.
*** Checking the style
The [[https://github.com/gonewest818/elisp-lint][elisp-lint]] and [[https://github.com/purcell/package-lint][package-lint]] packages are being used for checking the
style. You can run these checkers by performing:
#+BEGIN_SRC bash
$ make lint
#+END_SRC
*** Load test
In order to test that this theme can be actually loaded, run:
#+BEGIN_SRC bash
$ make load-test
#+END_SRC
** Issue reporting and submitting code
[[https://jo.mssola.com/en/contributing.html][Read this]].
|
