From e4d1db0cfddbf64ca571e1d84524a3f17223ebca Mon Sep 17 00:00:00 2001
From: Geoff Doty <n2geoff@gmail.com>
Date: Mon, 2 Apr 2018 06:24:55 -0400
Subject: [PATCH] added CONTRIBUTING doc

---
 CONTRIBUTING.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  6 ++---
 2 files changed, 74 insertions(+), 4 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ac0e83a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,72 @@
+# Contributing
+
+So you want to contribute, nice.  **Thank you**.
+
+Bug reports and code and documentation patches are all welcome. You can help this project also by using the development version and by reporting any bugs you might encounter.
+
+You may contribute in several ways like:
+
+* Creating new features
+* Fixing bugs
+* Improving documentation and examples
+* Translating any document here to your language
+
+## Table of contents
+
+* [Contributing](#contributing)
+  * [Developing](#developing)
+  * [Running tests](#running-tests)
+  * [Reporting a bug](#reporting-a-bug)
+  * [Request a feature](#request-a-feature)
+  * [Commit message](#commit-message)
+  * [Code style](#code-style)
+
+## Developing
+
+There is only one main source file in the project. It is the [/src/index.js](/src/index.js).
+The [test/index.spec.js](test/index.spec.js) is for now the only unit test file in the project.
+
+The `dist` includes the minified version of the source code.
+
+## Running tests
+
+Run unit tests using this command:
+
+```bash
+npm test
+```
+
+## Reporting a bug
+
+Use the [GitHub issue tracker](https://github.com/n2geoff/js-lib/issues) to report any bug you find.
+Bugs description should include:
+
+* How to reproduce the bug;
+* Easy to understand title;
+
+Would be nice to have some code showing how to reproduce the code, you may use [gist](https://gist.github.com) or [Codepen](https://codepen.io) for uploading your example code.
+
+## Request a feature
+
+Use the [GitHub issue tracker](https://github.com/n2geoff/js-lib/issues) to request a new feature.
+
+Keep in mind, this is a pure javascript library
+
+Feel free to port it to your favorite framework, such as [RiotJS](http://riotjs.com), Angular or VueJs in a new repository.
+
+## Commit message
+
+Commit messages should includes GitHub number reference and a imperative easy to understand sentence.
+
+## Coding style
+
+If it is supported in all major browers without transpiling, then please use those JavaScript language features in your code, with one caveat -- readablity is king. 
+
+Currently all ES5 and ES6/ES2015 are available.
+
+This project is linted agaist [JSHint](https://github.com/jshint/jshint) and the [`.jshintrc`](.jshintrc) is dead-simple, and all you need to followed. 
+
+Thank you for reading this.
+
+
+Hey, **star** this *repo* and/or share it with your friends.
\ No newline at end of file
diff --git a/README.md b/README.md
index ee44a7b..09b4a34 100644
--- a/README.md
+++ b/README.md
@@ -102,11 +102,9 @@ Please open [an issue](https://github.com/n2geoff/testit/issues/new) for support
 
 ## Contributing
 
-Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to realize these are early days, so...
-
-...enter at your own peril!
+Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the [guidelines](CONTRIBUTING.md), there minimalistic;)
 
 ## License
 
-The code is available under the [MIT license](LICENSE).
+[MIT](LICENSE).