10cec9c6b0
* idk how good this idea is * this could be working but i still cant figure out how to run it * ignore tags that mini.doc gens, but why? * chore(taskfile): force exiting after tests because i got infinit ci * chore(ci): add more nvim versions to run on * chore: update taskfile * feat: add docs generator * docs: its only begining * refactor: update docgen script * docs: write some more * docs(config): update * docs: update readme * language * hope it would work * what about that? * maybe this would work? * update md * upd * WHY DOESNT IT WORKING * idk by but 0.9.3 just fails the ci, so i deleted it from suite * again update, why does markdown not work in embeded html * maybe it can help? * upd * again update * kinda fix * fix: formatting * again some updating * some readme updating * fix, this shouldnt be in repo * i finnaly undertood how to fix this fking skill issue * fix(struct_tags): typo * refactor(docs): change the order in generated file * docs: install deps * refactor(scripts): rename doc-gen script * docs(impl): write docs * docs(dap): add doc * stylua . * docs(struct_tags): add doc * docs(gotests): add docs * docs(iferr): add docs * docs(comment): add doc * update CONTRIBUTING.md * docs(README): talk about `develop` branch * docs: update README.md
55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
# 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
|
|
|
|
Code is formatted by [stylua](https://github.com/JohnnyMorganz/StyLua) and linted using [selene](https://github.com/Kampfkarren/selene).
|
|
You can install these with:
|
|
|
|
```bash
|
|
sudo pacman -S selene stylua
|
|
# or whatever is your package manager
|
|
# or way of installing pkgs
|
|
```
|
|
|
|
For formatting use this following commands, or setup your editor to integrate with selene/stylua:
|
|
```bash
|
|
task format
|
|
task format:check # will check if your code formatted
|
|
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
|
|
|
|
You can generate docs with:
|
|
```bash
|
|
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 [plenary.nvim](https://github.com/nvim-lua/plenary.nvim).
|
|
All tests live in [/spec](https://github.com/olexsmir/gopher.nvim/tree/main/spec) dir.
|
|
|
|
You can run tests with:
|
|
```bash
|
|
task test
|
|
# also there are some aliases for that
|
|
task tests
|
|
task spec
|
|
```
|