mirror of
https://oauth2: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@github.com/m1ngsama/chopsticks.git
synced 2026-05-10 19:10:59 +08:00
1.1 KiB
1.1 KiB
Contributing
Rules
- No Node.js dependencies. The LSP engine is pure VimScript. Some language servers need Node — that's fine. The config itself must not.
- Startup matters. Run
vim -u .vimrc -i NONE --startuptime /tmp/s.log -es -N -c qa!before and after. If your change adds >1ms, it needs a good reason. - Works on TTY. Test over SSH. If it breaks in a terminal without true color, fix it or gate it behind
g:is_tty. - One module, one concern. Don't put git config in lsp.vim.
Adding a plugin
- Add the
Plugline tomodules/plugins.vim - If it's not needed at startup, lazy-load it:
Plug 'foo/bar', { 'on': 'FooCommand' } - Put config in the appropriate module
- Update the cheat sheet in
modules/tools.vimif you add keybindings - Test on both macOS and Linux
Reporting bugs
Open an issue. Include:
- OS and Vim version
- Whether you're on SSH/TTY
- Steps to reproduce
Code style
- Named augroups with
autocmd! - No comments explaining what — only why
exists('g:plugs["..."]')guards for plugin-dependent config- Test with
vim -u .vimrc -i NONE --startuptime /tmp/s.log -es -N -c qa!