Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (46 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 1.69 KB

Prerequisites

Development

Clone this repo into some place, e.g., ~/.vim-plugins

mkdir -p ~/.vim-plugins
cd ~/.vim-plugins
git clone https://github.com/autozimu/LanguageClient-neovim.git
cd LanguageClient-neovim
git checkout dev
# nix users can execute nix-shell at this point
make dev

Add this plugin to vim/neovim runtimepath,

set runtimepath+=~/.vim-plugins/LanguageClient-neovim

Put those settings inside vimrc,

let g:LanguageClient_devel = 1 " Use rust debug build
let g:LanguageClient_loggingLevel = 'INFO' " Optional, use higher logging level
  • Make necessary changes.
  • Execute make dev to build, format and lint.
  • Running separate vim/neovim. Verify changes.
  • Run tests. (See below section)

Run tests

(Option 1. Recommended) With docker installed,

make test && make integration-test-docker

(Option 2) Refer Dockerfile to install tests dependencies.

make test && make integration-test

Submit PR

Please submit pull request to dev branch. This is to avoid mismatch between vimscript and rust binary run by end user.

Release

  1. Update CHANGELOG.
  2. Issue command cargo release patch. Note you will need cargo-release installed. This will create a commit with updated version metadata, tag it, push to GitHub remote, which will then trigger Travis workflow to generate binaries.
  3. Once Travis workflow is finished successfully, rebase dev branch onto next branch.