Skip to content

Commit a483018

Browse files
committed
docs: Update to encourage usage of JSON
1 parent d5bc894 commit a483018

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,12 @@ Then add a script in `package.json` similar to this:
8585
Using [commitlint](https://commitlint.js.org) helps ensure we have well formed,
8686
thought out, semantic commit messages.
8787

88-
Create a file called `commitlint.config.js` in your project similar to this:
88+
Create a file called `.commitlintrc.json` in your project similar to this:
8989

90-
```js
91-
module.exports = {
92-
extends: [ '@uicpharm/standardization/commitlint.config.js' ],
93-
};
90+
```json
91+
{
92+
"extends": [ "@uicpharm/standardization/commitlint.config.js" ]
93+
}
9494
```
9595

9696
Then add a script in `package.json`, providing the first commit hash to begin linting
@@ -161,12 +161,12 @@ Then add a script in `package.json` in your project similar to this:
161161
Using [eslint](https://eslint.org) is critical to catch programming errors and maintain
162162
better coding conventions in JavaScript and TypeScript.
163163

164-
Create a file called `.eslintrc.js` in your project similar to this:
164+
Create a file called `.eslintrc.json` in your project similar to this:
165165

166-
```js
167-
module.exports = {
168-
extends: './node_modules/@uicpharm/standardization/.eslintrc.js',
169-
};
166+
```json
167+
{
168+
"extends": "./node_modules/@uicpharm/standardization/.eslintrc.js",
169+
}
170170
```
171171

172172
Then add a script in `package.json` in your project similar to this:

0 commit comments

Comments
 (0)