doc: minor doc updates per codacy

Fixes: #302
Fixes: #303
Fixes: #304
Fixes: #305
Fixes: #306
Fixes: #307
Fixes: #308
Fixes: #309
Fixes: #310
Fixes: #311
Fixes: #312

CODE_OF_CONDUCT.md

@@ -14,22 +14,19 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+  * Using welcoming and inclusive language
+  * Being respectful of differing viewpoints and experiences
+  * Gracefully accepting constructive criticism
+  * Focusing on what is best for the community
+  * Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  * The use of sexualized language or imagery and unwelcome sexual attention or advances
+  * Trolling, insulting/derogatory comments, and personal or political attacks
+  * Public or private harassment
+  * Publishing others' private information, such as a physical or electronic address, without explicit permission
+  * Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
@@ -68,9 +65,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
 
-[homepage]: https://www.contributor-covenant.org
+homepage: <https://www.contributor-covenant.org>
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+<https://www.contributor-covenant.org/faq>

CONTRIBUTING.md

@@ -34,10 +34,10 @@ git checkout -b my-contrib-branch
 Writing good commit logs is important. A commit log should describe what
 changed and why. Follow these guidelines when writing one:
 
-1. The first line should be 50 characters or less and contain a short
-   description of the change.
-2. Keep the second line blank.
-3. Wrap all other lines at 72 columns.
+  1. The first line should be 50 characters or less and contain a short
+    description of the change.
+  2. Keep the second line blank.
+  3. Wrap all other lines at 72 columns.
 
 Example of commit message:
 
@@ -86,12 +86,11 @@ Click the 'Pull Request' button and fill out the form.
 
 These are mostly notes for myself.
 
-* Make sure everything works: `make clean && npm install && make ci`
-* Run standard-version: `npm run release`
-* Push to GitHub: `git push --follow-tags origin master`
-* Publish to npmjs.com: `npm publish`
-* Assuming all goes well, head over to https://github.com/nodeshift/opossum/releases
-  and update the release with any relevant notes. The generated CHANGELOG.md file should
-  be updated, so you can use it to document release changes.
-* Tweet, blog and otherwise promote your awesome success!
-
+  * Make sure everything works: `make clean && npm install && make ci`
+  * Run standard-version: `npm run release`
+  * Push to GitHub: `git push --follow-tags origin master`
+  * Publish to npmjs.com: `npm publish`
+  * Assuming all goes well, head over to https://github.com/nodeshift/opossum/releases
+    and update the release with any relevant notes. The generated CHANGELOG.md file should
+    be updated, so you can use it to document release changes.
+  * Tweet, blog and otherwise promote your awesome success!

ISSUE_TEMPLATE.md

@@ -7,8 +7,8 @@ Please provide as much information as possible.
 3. Steps to recreate the issue
 -->
 
-**Node.js Version:**
+## Node.js Version:
 
-**Operating System:**
+## Operating System:
 
-**Steps to Produce Error:**
+## Steps to Produce Error:

README.md

@@ -151,17 +151,17 @@ $(() => {
 A `CircuitBreaker` will emit events for important things that occur.
 Here are the events you can listen for.
 
-* `fire` - emitted when the breaker is fired.
-* `reject` - emitted when the breaker is open (or halfOpen).
-* `timeout` - emitted when the breaker action times out.
-* `success` - emitted when the breaker action completes successfully
-* `failure` - emitted when the breaker action fails, called with the error
-* `open` - emitted when the breaker state changes to `open`
-* `close` - emitted when the breaker state changes to `closed`
-* `halfOpen` - emitted when the breaker state changes to `halfOpen`
-* `fallback` - emitted when the breaker has a fallback function and executes it
-* `semaphore-locked` - emitted when the breaker is at capacity and cannot execute the request
-* `health-check-failed` - emitted when a user-supplied health check function returns a rejected promise
+  * `fire` - emitted when the breaker is fired.
+  * `reject` - emitted when the breaker is open (or halfOpen).
+  * `timeout` - emitted when the breaker action times out.
+  * `success` - emitted when the breaker action completes successfully
+  * `failure` - emitted when the breaker action fails, called with the error
+  * `open` - emitted when the breaker state changes to `open`
+  * `close` - emitted when the breaker state changes to `closed`
+  * `halfOpen` - emitted when the breaker state changes to `halfOpen`
+  * `fallback` - emitted when the breaker has a fallback function and executes it
+  * `semaphore-locked` - emitted when the breaker is at capacity and cannot execute the request
+  * `health-check-failed` - emitted when a user-supplied health check function returns a rejected promise
 
 Handling events gives a greater level of control over your application behavior.
 
@@ -265,4 +265,3 @@ circuit.stats.getHystrixStream().setMaxListeners(100);
 ```
 
 Or it could be that you have a large test suite which exercises some code that creates `CircuitBreaker`s and does so repeatedly. If the `CircuitBreaker` being created is only needed for the duration of the test, use `circuit.shutdown()` when the circuit is no longer in use to clean up all listeners.
-

docs/index.html

@@ -435,7 +435,8 @@ <h2 id='readme' class='mt0'>
 
 
       <h1>opossum <a href="https://circleci.com/gh/nodeshift/opossum/tree/master"><img src="https://circleci.com/gh/nodeshift/opossum/tree/master.svg?style=svg&#x26;circle-token=0742302baa8c95cef354997ea52a383d3d078ff1" alt="CircleCI"></a></h1>
-<p><a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/nodeshift/opossum.svg" alt="Greenkeeper badge"></a>
+<p><a href="https://coveralls.io/github/nodeshift/opossum"><img src="https://coveralls.io/repos/github/nodeshift/opossum/badge.svg" alt="Coverage Status"></a>
+<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/nodeshift/opossum.svg" alt="Greenkeeper badge"></a>
 <a href="https://snyk.io/test/npm/opossum"><img src="https://snyk.io/test/npm/opossum/badge.svg" alt="Known Vulnerabilities"></a>
 <a href="https://david-dm.org/nodeshift/opossum"><img src="https://david-dm.org/nodeshift/opossum/status.svg" alt="dependencies Status"></a></p>
 <p><a href="https://npmjs.org/package/opossum"><img src="https://nodei.co/npm/opossum.png" alt="NPM"></a></p>
@@ -464,7 +465,7 @@ <h1>opossum <a href="https://circleci.com/gh/nodeshift/opossum/tree/master"><img
 </tr>
 <tr>
 <td>Documentation:</td>
-<td><a href="https://nodeshift.github.io/opossum/">https://nodeshift.github.io/opossum/</a></td>
+<td><a href="https://nodeshift.dev/opossum/">https://nodeshift.dev/opossum/</a></td>
 </tr>
 <tr>
 <td>Typngs:</td>