parent
76e817b5e1
commit
f23cb97d1a
37 changed files with 188 additions and 472 deletions
|
|
@ -1,14 +1,17 @@
|
|||
# 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
|
||||
```
|
||||
|
||||
### Formatting and linting
|
||||
### 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:
|
||||
|
||||
|
|
@ -19,31 +22,30 @@ sudo pacman -S selene stylua
|
|||
|
||||
For formatting use this following commands, or setup your editor to integrate with selene/stylua:
|
||||
```bash
|
||||
task format
|
||||
task lint
|
||||
task stylua
|
||||
task lint # lintering and format chewing
|
||||
```
|
||||
|
||||
### Documentation
|
||||
Here we're using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
|
||||
for generating vimhelp files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments.
|
||||
|
||||
For demo gifs in [readme](./README.md) we're using [vhs](https://github.com/charmbracelet/vhs).
|
||||
All files related to demos live in [/vhs](./vhs) dir.
|
||||
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 # generates vimhelp
|
||||
task vhs:generate # generates demo gifs
|
||||
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 test
|
||||
task tests
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue