The following is a set of guidelines for contributing to Vim for VSCode. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request. If you need help with Vim for VSCode, come visit our Slack community. Thanks for helping us make Vim for VSCode better!
The GitHub issue tracker is the preferred channel for tracking bugs and enhancement suggestions. When creating a new bug report do:
- Search against existing issues to check if somebody else has already reported your problem or requested your idea
- Include as many details as possible. Include screenshots/gifs and repro steps where applicable.
Pull requests are awesome. If you're looking to raise a PR for something which doesn't have an open issue, consider creating an issue first. When submitting a PR, ensure:
- Tests pass:
gulp: run tslint- Launch tests within VS Code
- Commits are squashed
-
Install prerequisites:
- latest Visual Studio Code
- Node.js v4.0.0 or higher
-
Fork and clone the repo, then
$ npm install -g gulp $ npm install
-
Open the folder in VS Code
- Refer to Visual Studio Code extension documentation
- Debug the extension in VS Code by adding breakpoints or
console.log("MY-MESSAGE");. - If you find issues or missing functionality with the VSCode Extensions API, try reporting the issue at VSCode Issues.
We are adhering to VSCode's coding guidelines.