Add CONTRIBUTING.md - general instruction for contributors

This commit is contained in:
Faisal Salman 2023-09-28 18:20:49 +07:00
parent ea4f145e64
commit 954ce35755
2 changed files with 8 additions and 0 deletions

7
CONTRIBUTING.md Normal file
View File

@ -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

View File

@ -190,6 +190,7 @@
], ],
"scripts": { "scripts": {
"build": "./script/build-dist.sh && ./script/build-module.js", "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", "fuzz": "jazzer ./test/jazzer-fuzz-test.js --sync",
"test": "./script/test-all.sh", "test": "./script/test-all.sh",
"test:eslint": "eslint src && eslint script", "test:eslint": "eslint src && eslint script",