Contributing to Marp for VS Code
Thank you for taking the time to read how to contribute to Marp for VS Code! This is the guideline for contributing to Marp for VS Code.
We are following the contributing guideline of marp-team projects. Please read these guidelines this before starting work in Marp for VS Code.
Typically using VS Code's debugger is good. See launch configurations on
- Build and run: Compile TypeScript and run compiled extension.
- Run: Only run compiled extension. It's useful running together with
yarn watch. Recommend to execute
Restart Debuggingmanually when updated source code.
- Run with extensions: Run compiled extension with enabled other installed extensions. It's useful to validate the race condition.
Marp team adopts Jest as test runner. This repository can run unit test by
NOTE: It seems to be difficult to run VSCode's E2E test on Jest. We're welcome to contribute for supporting E2E tests.
Publish to Visual Studio Marketplace (For maintainer)
A way to release is different from other projects of Marp Team targeted to npm.
yarn vsce:publish [major|minor|patch] at the latest
master branch. It can bump version and release to Marketplace at once. Don't forget
git push && git push --tags!