Skip to content
This repository was archived by the owner on Aug 16, 2023. It is now read-only.

Adding husky and pre-commit hooks #55

Merged
merged 3 commits into from
Oct 30, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Minor tweaks to README
redg-indeed committed Oct 30, 2020
commit 8128df46ad0eaa39b7e5ec15194a51d2f122b897
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -176,7 +176,9 @@ Run `npm run build` to compile the code to Javascript.

Run `node dist/examples/runFasterCode.js` (to use GraphQL) or `node dist/examples/runOldCode.ts` (to use REST calls), to run the example program. It requires internet access, since it calls the GitHub API. It will take a couple minutes to complete. Some of the output includes the word "ERROR", so don't panic.

Ensure to lint your code by running `npm run lint` before submitting any code for review. Either manually fix the errors or run `npm run lint:fix` to automatically fix any errors. Husky set up to run linting checks pre-commit which should prevent being able to commit linting errors; however, There is an [bug](https://github.com/typicode/husky/issues/639) in husky where occasionally the hooks won't run in an IDE.
Ensure to lint your code by running `npm run lint` before submitting any code for review. Either manually fix the errors or run `npm run lint:fix` to automatically fix any errors.

Husky is set up to run linting checks pre-commit which should prevent being able to commit linting errors; however, There is a [bug](https://github.com/typicode/husky/issues/639) in husky where occasionally the hooks won't run in an IDE.

## Local testing of the npm packaging