| 1 | **Before submitting a PR :**
|
| 2 | 1. Ensure your fork is created from `master` branch of [the repository](https://github.com/tediousjs/tedious).
|
| 3 | 2. Run `npm install` in the root folder.
|
| 4 | 3. After bug fix/code change, ensure all the existing tests and new tests (if any) pass (`npm run-script test-all`). During development, to run individual test use `node_modules/nodeunit test/<test_file.js> -t <test_name>`.
|
| 5 | 4. Build the driver (`npm run build`).
|
| 6 | 5. Run eslint and flow typechecker (`npm run lint`).
|
| 7 | 6. Run commitlint (`node_modules/.bin/commitlint --from origin/master --to HEAD`). Refer [commit conventions](https://commitlint.js.org/#/concepts-commit-conventions) and [commit rules](https://commitlint.js.org/#/reference-rules).
|
| 8 |
|
| 9 | **Thank you for Contributing!**
|