Skip to content

Commit

Permalink
📝 Add contributing and license sections
Browse files Browse the repository at this point in the history
  • Loading branch information
markbrouch committed Dec 20, 2019
1 parent 5dcaba9 commit 2d04a54
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 2d04a54

Please sign in to comment.