olexsmir.xyz
+6
-12
CONTRIBUTING.md
+6
-12
CONTRIBUTING.md
···
1
1
# Contributing to `gopher.nvim`
2
-
3
2
Thank you for taking the time to submit some code to gopher.nvim. It means a lot!
4
3
5
4
### Task running
6
-
7
5
In this codebase for running tasks is used [Taskfile](https://taskfile.dev).
8
6
You can install it with:
9
7
```bash
10
8
go install github.com/go-task/task/v3/cmd/task@latest
11
9
```
12
10
13
-
### Styling and formatting
14
-
11
+
### Formatting and linting
15
12
Code is formatted by [stylua](https://github.com/JohnnyMorganz/StyLua) and linted using [selene](https://github.com/Kampfkarren/selene).
16
13
You can install these with:
17
14
···
22
19
23
20
For formatting use this following commands, or setup your editor to integrate with selene/stylua:
24
21
```bash
25
-
task stylua
26
-
task lint # lintering and format chewing
22
+
task format
23
+
task lint
27
24
```
28
25
29
26
### Documentation
30
-
31
-
Here we are using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
32
-
for generating help files based on EmmyLua-like annotations in comments
27
+
Here we're using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
28
+
for generating help files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments.
33
29
34
30
You can generate docs with:
35
31
```bash
···
37
33
```
38
34
39
35
### Commit messages
40
-
41
36
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), please follow it.
42
37
43
38
### Testing
44
-
45
39
For testing this plugins uses [mini.test](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-test.md).
46
40
All tests live in [/spec](./spec) dir.
47
41
48
42
You can run tests with:
49
43
```bash
50
-
task tests
44
+
task test
51
45
```