-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Add contributing and license sections
- Loading branch information
1 parent
5dcaba9
commit 2d04a54
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -53,3 +53,49 @@ To change the output path of the generated `.eslintrc-todo` file, you can run `e | |
```bash | ||
eslint-generate-todo --path config/eslint-overrides.yml | ||
``` | ||
|
||
# Contributing | ||
|
||
Before contributing code to `eslint-generate-todo`, please read and sign the [Contributor License Agreement](CONTRIBUTOR_LICENSE_AGREEMENT.md). | ||
|
||
Clone the repository and install dependencies: | ||
|
||
```bash | ||
git clone [email protected]:doximity/eslint-generate-todo.git | ||
cd eslint-generate-todo | ||
yarn install | ||
``` | ||
|
||
To build `eslint-generate-todo`, you can run the `build` script: | ||
|
||
```bash | ||
yarn run build | ||
``` | ||
|
||
While developing, you can run the `dev` script to automatically rebuild as files change: | ||
|
||
```bash | ||
yarn run dev | ||
``` | ||
|
||
To lint code changes, you can run the `lint` script: | ||
|
||
```bash | ||
yarn run lint | ||
``` | ||
|
||
To format code using Prettier, you can run the `format` script: | ||
|
||
```bash | ||
yarn run format | ||
``` | ||
|
||
To run tests with Jest, you can run the `test` script: | ||
|
||
```bash | ||
yarn run test | ||
``` | ||
|
||
# License | ||
|
||
The `eslint-generate-todo` tool is offered under the [Apache v2](LICENSE) license. |