Optional badges such as npm version, test and build coverage, and so on.
One- or two-sentence description of what the module does.
Optionally, include a section of one or two paragraphs with more high-level information on what the module does, what problems it solves, why one would use it and how. Don't just repeat what's in the summary.
$ npm install module-name
General description of how to use the module with basic example.
Full API documentation.
Additional examples here.
What tests are included and how to run them.
This project welcomes contributions from the community. Contributions are accepted using GitHub pull requests; for more information, see GitHub documentation - Creating a pull request.
For a good pull request, we ask you provide the following:
- Include a clear description of your pull request in the description with the basic "what" and "why"s for the request.
- The tests should pass as best as you can. GitHub will automatically run the tests as well, to act as a safety net.
- The pull request should include tests for the change. A new feature should
have tests for the new feature and bug fixes should include a test that fails
without the corresponding code change and passes after they are applied.
npm run test-covwill generate a
coverage/folder that contains HTML pages of the code coverage, to better understand if everything you're adding is being tested.
- If the pull request is a new feature, please include appropriate documentation
README.mdfile as well.
- To help ensure that your code is similar in style to the existing code,
run the command
npm run lintand fix any displayed issues.
Names of module "owners" (lead developers) and other developers who have contributed.
Link to the license, with a short description of what it is, e.g. "MIT" or whatever.