Skip to content

Commit

Permalink
feat: add contribution (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
linrongbin16 committed Jun 16, 2023
1 parent e461bf3 commit 135d990
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 10 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contribute

## Lint

Use [lua-language-server](https://github.com/LuaLS/lua-language-server) for code
lint.

## Formatting

Use [stylua](https://github.com/JohnnyMorganz/StyLua) for code formatting.

## Test

Start neovim and run:

```lua
require('gitlinker.test.test_rules')
```
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,13 +194,3 @@ require('gitlinker').setup({
file_log = false,
})
````

## Contribute

### Code format

Use [stylua](https://github.com/JohnnyMorganz/StyLua) for code formatting.

### Test pattern rules

Run test cases in [lua/gitlinker/test](https://github.com/linrongbin16/gitlinker.nvim/tree/master/lua/gitlinker/test).
2 changes: 2 additions & 0 deletions lua/gitlinker.lua
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,8 @@ end
local M = {
setup = setup,
link = link,
-- for unit testing
map_remote_to_host = map_remote_to_host,
}

return M

0 comments on commit 135d990

Please sign in to comment.