From 954ce3575567ce528df256b6f8a73ef041d72455 Mon Sep 17 00:00:00 2001 From: Faisal Salman Date: Thu, 28 Sep 2023 18:20:49 +0700 Subject: [PATCH] Add CONTRIBUTING.md - general instruction for contributors --- CONTRIBUTING.md | 7 +++++++ package.json | 1 + 2 files changed, 8 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f7ac0d6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ +# UAParser.js: How to Contribute + +* Fork and clone this repository +* Make some changes as required +* Write unit test to showcase its functionality under `/test` +* Run the test suites to make sure it's not breaking anything `$ npm run build+test` +* Submit a pull request under `develop` branch & check the CLA in the submission form \ No newline at end of file diff --git a/package.json b/package.json index ae0e7f2..444f870 100644 --- a/package.json +++ b/package.json @@ -190,6 +190,7 @@ ], "scripts": { "build": "./script/build-dist.sh && ./script/build-module.js", + "build+test": "npm run build && npm run test", "fuzz": "jazzer ./test/jazzer-fuzz-test.js --sync", "test": "./script/test-all.sh", "test:eslint": "eslint src && eslint script",