Add a CONTRIBUTING.md file, and try to make contribution generally a bit easier

Author: stephencookdev

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+
+Contributors are welcome to help out with this repository! 😊
+
+Please follow this guide when raising issues, and contributing to the SMP repository.
+
+## Raising an Issue
+
+If you're raising an issue with SMP being incompatible with a particular webpack config, plugin, or loader - then please include reproduction steps.
+
+The ideal reproduction steps would be forking this repository, and adding a new [\_\_tests\_\_/setups](./__tests__/setups) test case.
+
+## Raising a Pull Request
+
+SMP uses [Prettier](https://github.com/prettier/prettier) for its code formatting.
+
+If possible, please also include a new unit test (e.g. [utils.test.js](./utils.test.js)), or integration test (i.e. [\_\_tests\_\_/setups](./__tests__/setups)).
+
+## Code Structure
+
+SMP has 2 primary parts:
+
+1. The [SMP class](./index.js) contains the `smp.wrap` instance method that bootstraps the whole wrapping sequence. This class also listens for basic timing events, and orchestrates the main timings.
+2. The [`WrappedPlugin`](./WrappedPlugin) proxy that wraps each webpack plugin. This uses a `Proxy` to wrap everything to do with a plugin, feeding the timing information back to the SMP class.

README.md

@@ -7,7 +7,8 @@
 
   <a href="https://travis-ci.org/stephencookdev/speed-measure-webpack-plugin"><img src="https://travis-ci.org/stephencookdev/speed-measure-webpack-plugin.svg?branch=master" /></a>
   <a href="https://npmjs.com/package/speed-measure-webpack-plugin"><img src="https://img.shields.io/npm/dw/speed-measure-webpack-plugin.svg" /></a>
-  <a href="https://npmjs.com/package/speed-measure-webpack-plugin"><img src="https://img.shields.io/node/v/speed-measure-webpack-plugin.svg" /></a>
+  <a href="https://npmmjs.com/package/speed-measure-webpack-plugin"><img src="https://img.shields.io/node/v/speed-measure-webpack-plugin.svg" /></a>
+  <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg" /></a>
 </div>
 <br>
 
@@ -29,10 +30,6 @@ or
 yarn add -D speed-measure-webpack-plugin
 ```
 
-## Migrating
-
-SMP follows [semver](https://semver.org/). If upgrading a major version, you can consult [the migration guide](./migration.md).
-
 ## Requirements
 
 SMP requires at least **Node v6**. But otherwise, accepts **all webpack** versions (1, 2, 3, and 4).
@@ -144,6 +141,16 @@ This flag is _experimental_. Some loaders will have inaccurate results:
 
 We will find solutions to these issues before removing the _(experimental)_ flag on this option.
 
+## Contributing
+
+Contributors are welcome! 😊
+
+Please check out the [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## Migrating
+
+SMP follows [semver](https://semver.org/). If upgrading a major version, you can consult [the migration guide](./migration.md).
+
 ## License
 
 [MIT](/LICENSE)

__tests__/setups/v1-plain/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "description": "Test webpack v1 with SMP",
   "scripts": {
+    "full-test": "npm run prepare && npm run test && npm run cleanup",
     "prepare": "cp -r ../../common/* .",
     "test": "jest ./smp.test.js",
     "cleanup": "rm -rf dist",

__tests__/setups/v2-plain/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "description": "Test webpack v2 with SMP",
   "scripts": {
+    "full-test": "npm run prepare && npm run test && npm run cleanup",
     "prepare": "cp -r ../../common/* .",
     "test": "jest ./smp.test.js",
     "cleanup": "rm -rf dist",

__tests__/setups/v3-circular-plugin/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "description": "Test webpack v3 and a plugin with circular references, with SMP",
   "scripts": {
+    "full-test": "npm run prepare && npm run test && npm run cleanup",
     "prepare": "cp -r ../../common/* .",
     "test": "jest ./smp.test.js",
     "cleanup": "rm -rf dist",

__tests__/setups/v3-hard-source-webpack-plugin/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "description": "Test webpack v3, and HardSourceWebpackPlugin with SMP",
   "scripts": {
+    "full-test": "npm run prepare && npm run test && npm run cleanup",
     "prepare": "cp -r ../../common/* .",
     "test": "jest ./smp.test.js",
     "cleanup": "rm -rf dist && rm -rf node_modules/.cache",

__tests__/setups/v3-plain/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "description": "Test webpack v3 with SMP",
   "scripts": {
+    "full-test": "npm run prepare && npm run test && npm run cleanup",
     "prepare": "cp -r ../../common/* .",
     "test": "jest ./smp.test.js",
     "cleanup": "rm -rf dist",

__tests__/setups/v3-stats/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "description": "Test webpack v3 with a StatsPlugin set-up with SMP",
   "scripts": {
+    "full-test": "npm run prepare && npm run test && npm run cleanup",
     "prepare": "cp -r ../../common/* .",
     "test": "jest ./smp.test.js",
     "cleanup": "rm -rf dist",

__tests__/setups/v4-circular-plugin/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "description": "Test webpack v4 and a plugin with circular references, with SMP",
   "scripts": {
+    "full-test": "npm run prepare && npm run test && npm run cleanup",
     "prepare": "cp -r ../../common/* .",
     "test": "jest ./smp.test.js",
     "cleanup": "rm -rf dist",

__tests__/setups/v4-hard-source-webpack-plugin/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "description": "Test webpack v4, and HardSourceWebpackPlugin with SMP",
   "scripts": {
+    "full-test": "npm run prepare && npm run test && npm run cleanup",
     "prepare": "cp -r ../../common/* .",
     "test": "jest ./smp.test.js",
     "cleanup": "rm -rf dist && rm -rf node_modules/.cache",