Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 1.98 KB
Raw

Contribution

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

Any contribution is welcome.

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

Install

npm install
npm test

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 rum compile
npx mocha ./out/test/Documentation.test.js ./out/test/ESLint.test.js

Publishing to market

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

Checklist

  • Are the tests are running? (npm test)
  • Is the CHANGELOG.md was updated?

TODOs

  • 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
  • dependsOn could contain variables
  • https://github.com/nodejs/node-gyp