Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pinpong committed Sep 15, 2023
1 parent 5bb8c23 commit 82d0064
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 69 deletions.
2 changes: 2 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

yarn format
yarn lint
npm test
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,12 @@ try {
console.log(e);
}
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests.
```sh
yarn install && yarn prepare
```
16 changes: 9 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,25 @@
"build": "rm -rf ./dist && tsc",
"test": "jest",
"format": "yarn prettier . --write",
"lint": "eslint ."
"lint": "eslint .",
"prepare": "husky install"
},
"devDependencies": {
"@jest/globals": "29.7.0",
"@trivago/prettier-plugin-sort-imports": "^4.2.0",
"@trivago/prettier-plugin-sort-imports": "4.2.0",
"@types/jest": "29.5.4",
"@typescript-eslint/eslint-plugin": "6.7.0",
"@typescript-eslint/parser": "6.7.0",
"eslint": "8.49.0",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-import": "^2.28.1",
"eslint-plugin-jsdoc": "^46.8.0",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-import": "2.28.1",
"eslint-plugin-jsdoc": "46.8.0",
"husky": "8.0.3",
"jest": "29.7.0",
"prettier": "3.0.3",
"ts-jest": "29.1.1",
"typedoc": "^0.25.1",
"typedoc-plugin-missing-exports": "^2.1.0",
"typedoc": "0.25.1",
"typedoc-plugin-missing-exports": "2.1.0",
"typescript": "5.2.2"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion test/utils/stringUtils.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { ItemStatusResponse, SystemStatusResponse } from '../../src/client';
import { CLIENT_ERROR } from '../../src/errors';
import {
systemFilteredByGroup,
Expand Down
Loading

0 comments on commit 82d0064

Please sign in to comment.