gopher.nvim/CONTRIBUTING.md

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. You can install it with:

go install github.com/go-task/task/v3/cmd/task@latest

Styling and formatting

Code is formatted by stylua and linted using selene. You can install these with:

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:

task format
task format:check  # will check if your code formatted
task lint

Documentation

Here we are using mini.doc for generating help files based on EmmyLua-like annotations in comments

You can generate docs with:

task docgen

Commit messages

We use Conventional Commits, please follow it.

Testing

For testing this plugins uses plenary.nvim. All tests live in /spec dir.

You can run tests with:

task tests