diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef377e2..257d94a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,14 @@ # 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 - +### Formatting and linting Code is formatted by [stylua](https://github.com/JohnnyMorganz/StyLua) and linted using [selene](https://github.com/Kampfkarren/selene). 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: ```bash -task stylua -task lint # lintering and format chewing +task format +task lint ``` ### 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 +Here we're 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. You can generate docs with: ```bash @@ -37,15 +33,13 @@ 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 +task test ```