Skip to content

Commit

Permalink
doc: document how to add a new module
Browse files Browse the repository at this point in the history
  • Loading branch information
watson authored and MylesBorins committed Jul 19, 2017
1 parent dc2bea1 commit 3ed03ae
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -72,3 +72,14 @@ OR
* The module is under the Node.js foundation Github org
OR
* The module is identified as an important module by a Node.js Working Group

#### Procedure

After making sure you adhere to the above requirements, do the
following:

1. Add the module to
[`lib/lookup.json`](https://github.com/nodejs/citgm/blob/master/lib/lookup.json)
1. Run `npm link`
1. Make sure the `citgm <module>` tests pass
1. Commit your changes and open a PR. Please specify the hard and soft requirements the module fufills

0 comments on commit 3ed03ae

Please sign in to comment.