Skip to content

Latest commit

 

History

History
83 lines (57 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

83 lines (57 loc) · 3.23 KB
Raw

Travis build status Appveyor build status GitHub license Code Style: Prettier

Contribution

Author's note:

This extension is my way of giving back / saying thanks to the open-source community. If you are an open-source contributor then I take it as you already thanked. :)

Otherwise if you wanna express yourself you can buy me a coffee. Or you can just rate the extension. Whatever fits your budget.

Contributing to the source

  • Report a bug ("properly").
  • Tell me about your desired features.
  • Create a pull request (against the development branch or master (if you sure your your PR is ready to be deployed)).

Clone Repo

It is recommended to create a push hook:

cp ./resources/githooks/pre-push ./.git/hooks/pre-push

Content of .git/hooks/pre-push file:

#!/bin/sh
echo "pre-push hook:"
set -e -x
npm audit --production
npm run compile
npx mocha ./out/test/Documentation.test.js ./out/test/ESLint.test.js

Install

npm install

Test

After installing:

npm test

Debug

After installing:

  1. Open the folder in VSCode: code .
  2. Run task: npm watch. Wait until it is compiled.
  3. VSCode "Run" / Debug page: Select Manual cpp.
  4. Start debugging
  5. Add your folder to the newly opened VSCode's workspace (Or change launch.json's Manual cpp to the folder which is intended to be debugged and the start.)

Issues are tipically related to file operations:

Publishing to market

If you think your changes worth of a release add a new version entry to CHANGELOG.md file without a date. Travis will publish it automatically.

TODOs

  • https://www.npmjs.com/package/fast-xml-parser
  • doctest: supporting test suites
  • Test cases: google test, catch2: info, warn, fail, stdout, stderr, capture, gtest_skip, gmock_verbose
  • gaze is not good enough: detects change and delete, but not creation

VSCE_PAT