9aa0038125
* refactor: remove autoload * since nvim 0.9 health.lua files are threaded as checkhealth provider * prof of concept * fix(runner.gocmd)!: i forgot to update it when i was working on #85 * fix(plugin): now commands register properly * fix(plugin): fix command name for :GoIfErr * fix(plugin): respect `setup_commands` option * docs: update * refactor(plugin): use vim.schedule * docs: update CONTRIBUTING
51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
# Contributing to `gopher.nvim`
|
|
|
|
Thank you for taking the time to submit some code to gopher.nvim. It means a lot!
|
|
|
|
### Task running
|
|
|
|
In this codebase for running tasks is used [Taskfile](https://taskfile.dev).
|
|
You can install it with:
|
|
```bash
|
|
go install github.com/go-task/task/v3/cmd/task@latest
|
|
```
|
|
|
|
### Styling and formatting
|
|
|
|
Code is formatted by [stylua](https://github.com/JohnnyMorganz/StyLua) and linted using [selene](https://github.com/Kampfkarren/selene).
|
|
You can install these with:
|
|
|
|
```bash
|
|
sudo pacman -S selene stylua
|
|
# or whatever is your package manager
|
|
```
|
|
|
|
For formatting use this following commands, or setup your editor to integrate with selene/stylua:
|
|
```bash
|
|
task stylua
|
|
task lint # lintering and format chewing
|
|
```
|
|
|
|
### Documentation
|
|
|
|
Here we are using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
|
|
for generating help files based on EmmyLua-like annotations in comments
|
|
|
|
You can generate docs with:
|
|
```bash
|
|
task docgen
|
|
```
|
|
|
|
### Commit messages
|
|
|
|
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), please follow it.
|
|
|
|
### Testing
|
|
|
|
For testing this plugins uses [mini.test](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-test.md).
|
|
All tests live in [/spec](./spec) dir.
|
|
|
|
You can run tests with:
|
|
```bash
|
|
task tests
|
|
```
|