JIe
2bb7059579
Some checks failed
Detach Plugins / check (FlyGrep.vim) (push) Has been cancelled
Detach Plugins / check (GitHub.vim) (push) Has been cancelled
Detach Plugins / check (JavaUnit.vim) (push) Has been cancelled
Detach Plugins / check (SourceCounter.vim) (push) Has been cancelled
Detach Plugins / check (cpicker.nvim) (push) Has been cancelled
Detach Plugins / check (dein-ui.vim) (push) Has been cancelled
Detach Plugins / check (git.vim) (push) Has been cancelled
Detach Plugins / check (iedit.vim) (push) Has been cancelled
Detach Plugins / check (scrollbar.vim) (push) Has been cancelled
Detach Plugins / check (vim-chat) (push) Has been cancelled
Detach Plugins / check (vim-cheat) (push) Has been cancelled
Detach Plugins / check (vim-todo) (push) Has been cancelled
Detach Plugins / check (xmake.vim) (push) Has been cancelled
test / Linux (nvim, nightly) (push) Has been cancelled
test / Linux (nvim, v0.3.8) (push) Has been cancelled
test / Linux (nvim, v0.4.0) (push) Has been cancelled
test / Linux (nvim, v0.4.2) (push) Has been cancelled
test / Linux (nvim, v0.4.3) (push) Has been cancelled
test / Linux (nvim, v0.4.4) (push) Has been cancelled
test / Linux (nvim, v0.5.0) (push) Has been cancelled
test / Linux (nvim, v0.5.1) (push) Has been cancelled
test / Linux (nvim, v0.6.0) (push) Has been cancelled
test / Linux (nvim, v0.6.1) (push) Has been cancelled
test / Linux (nvim, v0.7.0) (push) Has been cancelled
test / Linux (nvim, v0.7.2) (push) Has been cancelled
test / Linux (nvim, v0.8.0) (push) Has been cancelled
test / Linux (nvim, v0.8.1) (push) Has been cancelled
test / Linux (nvim, v0.8.2) (push) Has been cancelled
test / Linux (nvim, v0.8.3) (push) Has been cancelled
test / Linux (nvim, v0.9.0) (push) Has been cancelled
test / Linux (nvim, v0.9.1) (push) Has been cancelled
test / Linux (true, vim, v7.4.052) (push) Has been cancelled
test / Linux (true, vim, v7.4.1689) (push) Has been cancelled
test / Linux (true, vim, v7.4.629) (push) Has been cancelled
test / Linux (true, vim, v8.0.0027) (push) Has been cancelled
test / Linux (true, vim, v8.0.0183) (push) Has been cancelled
test / Linux (vim, nightly) (push) Has been cancelled
test / Linux (vim, v8.0.0184) (push) Has been cancelled
test / Linux (vim, v8.0.1453) (push) Has been cancelled
test / Linux (vim, v8.1.2269) (push) Has been cancelled
test / Linux (vim, v8.2.2434) (push) Has been cancelled
test / Linux (vim, v8.2.3995) (push) Has been cancelled
test / Windows (nvim, nightly) (push) Has been cancelled
test / Windows (nvim, v0.3.8) (push) Has been cancelled
test / Windows (nvim, v0.4.2) (push) Has been cancelled
test / Windows (nvim, v0.4.3) (push) Has been cancelled
test / Windows (nvim, v0.4.4) (push) Has been cancelled
test / Windows (nvim, v0.5.0) (push) Has been cancelled
test / Windows (nvim, v0.5.1) (push) Has been cancelled
test / Windows (nvim, v0.6.0) (push) Has been cancelled
test / Windows (nvim, v0.6.1) (push) Has been cancelled
test / Windows (nvim, v0.7.0) (push) Has been cancelled
test / Windows (nvim, v0.7.2) (push) Has been cancelled
test / Windows (nvim, v0.8.0) (push) Has been cancelled
test / Windows (nvim, v0.8.1) (push) Has been cancelled
test / Windows (nvim, v0.8.2) (push) Has been cancelled
test / Windows (nvim, v0.8.3) (push) Has been cancelled
test / Windows (nvim, v0.9.0) (push) Has been cancelled
test / Windows (nvim, v0.9.1) (push) Has been cancelled
test / Windows (vim, nightly) (push) Has been cancelled
test / Windows (vim, v7.4.1185) (push) Has been cancelled
test / Windows (vim, v7.4.1689) (push) Has been cancelled
test / Windows (vim, v8.0.0027) (push) Has been cancelled
test / Windows (vim, v8.0.1453) (push) Has been cancelled
test / Windows (vim, v8.1.2269) (push) Has been cancelled
test / Windows (vim, v8.2.2434) (push) Has been cancelled
test / Windows (vim, v8.2.3995) (push) Has been cancelled
docker / docker (push) Has been cancelled
mirror / check (coding) (push) Has been cancelled
mirror / check (gitee) (push) Has been cancelled
mirror / check (gitlab) (push) Has been cancelled
59 lines
2.2 KiB
Markdown
59 lines
2.2 KiB
Markdown
# Contributing to Neo-tree
|
|
|
|
Contributions are welcome! To keep everything clean and tidy, please follow the
|
|
guidelines below.
|
|
|
|
## Code Style
|
|
|
|
This is open for debate, but here is the current style choices being observed:
|
|
|
|
- snake_case for all variables and functions
|
|
- unless it is a class, then use PascalCase
|
|
- other OOP things, like method names should use camelCase
|
|
- BUT we don't currently have any OOP parts and I don't think we want any
|
|
|
|
I prefer `local name = function()` over `local function name()`, just to be
|
|
consistent with the `M.name = function()` exports.
|
|
|
|
### StyLua
|
|
|
|
We use (StyLua)[https://github.com/JohnnyMorganz/StyLua] to enforce consistency
|
|
in code. You should install it on your local machine. PRs will be checked with
|
|
this tool.
|
|
|
|
## Commit Messages
|
|
|
|
We use **semantic**, aka **conventional** commit messages. The official guide
|
|
can be found here: https://www.conventionalcommits.org/en/v1.0.0/
|
|
|
|
You can also just take a look at the commit history to get the idea. The
|
|
optional scope for this project would usually be the source, i.e.
|
|
`feat(filesystem): add awesome feature that does xyz`.
|
|
|
|
## Branching
|
|
|
|
The default branch is set to the current major version to make it simple for end
|
|
users visiting the repo. Pull Requests, however, should go to the `main`
|
|
branch. After a short testing period, it will be merged to the current release
|
|
branch.
|
|
|
|
This project requires a **linear history**. I don't trust merge commits.
|
|
This means you will have to rebase your branch on main before the pull request
|
|
can be merged. This can get a bit annoying in a busy repository, but I think it
|
|
is worth the effort.
|
|
|
|
## Documentation
|
|
|
|
All new features should be documented in the commit they were added in. The
|
|
current strategy is to maintain:
|
|
|
|
- Config Options: added to [defaults](lua/neo-tree/defaults.lua) and described
|
|
in comments
|
|
- The README contains "back of the box" high level overview of features. It is
|
|
meant for people trying to decide if they want to install this plugin or not.
|
|
It should include references to the help file for more information:
|
|
`:h neo-tree-setup`
|
|
- The vim help file [doc/neo-tree.txt](doc/neo-tree.txt) is the definitive
|
|
reference and should contain all information needed to configure and use the
|
|
plugin.
|