docs: update CONTRIBUTING

This commit is contained in:
Oleksandr Smirnov 2025-03-21 21:39:39 +02:00
parent 20e06a6fd2
commit 15a5a8cba5
No known key found for this signature in database
2 changed files with 5 additions and 16 deletions

View file

@ -22,9 +22,8 @@ sudo pacman -S selene stylua
For formatting use this following commands, or setup your editor to integrate with selene/stylua: For formatting use this following commands, or setup your editor to integrate with selene/stylua:
```bash ```bash
task format task stylua
task format:check # will check if your code formatted task lint # lintering and format chewing
task lint
``` ```
### Documentation ### Documentation
@ -43,8 +42,8 @@ We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), p
### Testing ### Testing
For testing this plugins uses [plenary.nvim](https://github.com/nvim-lua/plenary.nvim). For testing this plugins uses [mini.test](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-test.md).
All tests live in [/spec](https://github.com/olexsmir/gopher.nvim/tree/main/spec) dir. All tests live in [/spec](./spec) dir.
You can run tests with: You can run tests with:
```bash ```bash

View file

@ -1,26 +1,16 @@
version: "3" version: "3"
tasks: tasks:
format:
desc: formats all lua files in repo
cmds:
- stylua .
lint: lint:
desc: runs all linters desc: runs all linters
cmds: cmds:
- task: selene - task: selene
- task: stylua:check - stylua --check .
selene: selene:
desc: runs lua linter(selene) desc: runs lua linter(selene)
cmds: cmds:
- selene . - selene .
stylua:check:
desc: runs stylua in check mode
cmds:
- stylua --check .
stylua: stylua:
desc: runs lua formatter desc: runs lua formatter
cmds: cmds: