olexsmir/gopher.nvim
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: update CONTRIBUTING.md

Browse source
This commit is contained in:
Oleksandr Smirnov 2025-08-29 21:21:00 +03:00
parent d05b8500c3
commit b09d596738
1 changed files with 6 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.md
View file

@ -1,17 +1,14 @@
# Contributing to `gopher.nvim` # Contributing to `gopher.nvim`
Thank you for taking the time to submit some code to gopher.nvim. It means a lot! Thank you for taking the time to submit some code to gopher.nvim. It means a lot!
### Task running ### Task running
In this codebase for running tasks is used [Taskfile](https://taskfile.dev). In this codebase for running tasks is used [Taskfile](https://taskfile.dev).
You can install it with: You can install it with:
```bash ```bash
go install github.com/go-task/task/v3/cmd/task@latest go install github.com/go-task/task/v3/cmd/task@latest
``` ```
### Styling and formatting ### Formatting and linting
Code is formatted by [stylua](https://github.com/JohnnyMorganz/StyLua) and linted using [selene](https://github.com/Kampfkarren/selene). Code is formatted by [stylua](https://github.com/JohnnyMorganz/StyLua) and linted using [selene](https://github.com/Kampfkarren/selene).
You can install these with: You can install these with:
@ -22,14 +19,13 @@ 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 stylua task format
task lint # lintering and format chewing task lint
``` ```
### Documentation ### Documentation
Here we're using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
Here we are using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md) for generating help files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments.
for generating help files based on EmmyLua-like annotations in comments
You can generate docs with: You can generate docs with:
```bash ```bash
@ -37,15 +33,13 @@ task docgen
``` ```
### Commit messages ### Commit messages
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), please follow it. We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), please follow it.
### Testing ### Testing
For testing this plugins uses [mini.test](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-test.md). 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. All tests live in [/spec](./spec) dir.
You can run tests with: You can run tests with:
```bash ```bash
task tests task test
``` ```