Skip to content

Commit

Permalink
chore(deps): Install @logdna/commitlint-config@2.0.0
Browse files Browse the repository at this point in the history
This package will enforce Conventional commit style to be in line
with the Company's preference. Public PRs will have to adhere to
those standards for their commit messages.

Fixes: #72
  • Loading branch information
darinspivey committed Jun 29, 2022
1 parent 9b98c4a commit 158a5ea
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
* **[Using with AWS Lambda](#using-with-aws-lambda)**
* **[Proxy Support](#proxy-support)**
* **[License](#license)**
* **[Contributing](#contributing)**

## Migrating From Other Versions

Expand Down Expand Up @@ -613,6 +614,16 @@ Copyright © [LogDNA](https://logdna.com), released under an MIT license. See th

*Happy Logging!*

## Contributing

This project is open-sourced, and accepts PRs from the public for bugs or feature
enhancements. These are the guidelines for contributing:

* The project uses [Commitlint][] and enforces [Conventional Commit Standard][]. Please format your commits based on these guidelines.
* An [issue must be opened](https://github.com/logdna/logger-node/issues) in the repository for any bug, feature, or anything else that will have a PR
* The commit message must reference the issue with an [acceptable action tag](https://github.com/logdna/commitlint-config/blob/41aef3b69f292e39fb41a5ef24bcd7043e0fceb3/index.js#L12-L20) in the commit footer, e.g. `Fixes: #5`


[`<Boolean>`]: https://mdn.io/boolean
[`<Number>`]: https://mdn.io/number
[`<Object>`]: https://mdn.io/object
Expand All @@ -621,6 +632,8 @@ Copyright © [LogDNA](https://logdna.com), released under an MIT license. See th
[`<TypeError>`]: https://mdn.io/TypeError
[`<RangeError>`]: https://mdn.io/RangeError
[`<Error>`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
[Commitlint]: https://commitlint.js.org
[Conventional Commit Standard]: https://www.conventionalcommits.org/en/v1.0.0/

## Contributors ✨

Expand Down
12 changes: 10 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@
},
"scripts": {
"lint": "eslint .",
"pretest": "npm run lint",
"pretest": "npm run lint && npm run commitlint",
"test": "tap",
"pretest:ci": "npm run lint",
"test:ci": "tools/test-ci.sh",
"release": "semantic-release",
"release:dry": "semantic-release --dry-run --no-ci --branches=${BRANCH_NAME:-main}"
"release:dry": "semantic-release --dry-run --no-ci --branches=${BRANCH_NAME:-main}",
"commitlint": "commitlint --from=origin/main --to=HEAD"
},
"files": [
"lib/",
Expand Down Expand Up @@ -72,6 +73,11 @@
"publishConfig": {
"access": "public"
},
"commitlint": {
"extends": [
"@logdna/commitlint-config"
]
},
"tap": {
"100": true,
"ts": false,
Expand Down Expand Up @@ -105,6 +111,8 @@
"json-stringify-safe": "^5.0.1"
},
"devDependencies": {
"@logdna/commitlint-config": "^2.0.0",
"commitlint": "^17.0.3",
"eslint": "^8.18.0",
"eslint-config-logdna": "^6.1.0",
"nock": "^13.1.3",
Expand Down

0 comments on commit 158a5ea

Please sign in to comment.