Skip to content
This repository has been archived by the owner on Aug 20, 2020. It is now read-only.

Commit

Permalink
changes after review
Browse files Browse the repository at this point in the history
  • Loading branch information
maxtotterman committed Oct 27, 2017
1 parent 8a8b78c commit bf54dda
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
14 changes: 1 addition & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,18 +120,6 @@ Run the test:

`mocha`

### Documentation

If you would like to auto-generate documentation of the packages, you can do so locally by running:

`./node_modules/.bin/esdoc`

Using the .esdoc.json file, esdoc will create documentation in the docs directory.

### Checking docs coverage

You will find a coverage.json file in the **docs** directory. This will contain information about the documentation coverage for each of the different files in this repo.

<a name="style-guidelines-and-naming-conventions"></a>
## Style Guidelines & Naming Conventions

Expand All @@ -142,7 +130,7 @@ Generally, we follow the style guidelines as suggested by the official language.
Please run your code through:

- [ESLint](http://eslint.org/) with the standard style guide.
- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#testing) to check the documentation coverage of your added code.
- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/USAGE.md) to check the documentation coverage of your added code.

<a name="creating-a-pull-request"></a>
## Creating a Pull Request
Expand Down
12 changes: 12 additions & 0 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,15 @@ To run the example:
```bash
node examples/example
```

# Documentation

If you would like to auto-generate documentation of the packages, you can do so locally by running:

`./node_modules/.bin/esdoc`

Using the .esdoc.json file, esdoc will create documentation in the docs directory.

## Checking docs coverage

You will find a coverage.json file in the **docs** directory. This will contain information about the documentation coverage for each of the different files in this repo.

0 comments on commit bf54dda

Please sign in to comment.