Test settings updates and Contributing Guide

Author: Dipu Raj

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+## What can I contribute?
+- Fix a bug you found or already reported on the [GitHub Issues Tracker](https://github.com/techlab/SmartWizard/issues/). 
+- Add new features to the project.
+- Add new test cases.
+- Add documentation  
+- Add a demo page
+- [Donate](https://www.paypal.me/dipuraj) money for the project on [Paypal](https://www.paypal.me/dipuraj)
+
+## How to contribute code
+Here are the basic steps to get started contributing:
+
+1. Fork the [repo](https://github.com/techlab/SmartWizard/) and get development running on your computer.
+2. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
+3. Change the code to fix the bug or add the feature. All changes should happen in the relevant `src/js/*.js` and `src/css/*.css` files.
+4. Build the code by running `npm run build` or `gulp build`
+5. Run the test cases by running `npm test` or `gulp test`, you can also add more test cases based on your new change.
+6. Verify that your fix or feature works. 
+7. Commit your changes with an informative description
+8. Open a pull request to the [repo](https://github.com/techlab/SmartWizard/) with your new commit and a descriptive message about what the PR does.
+
+## Reporting bugs
+### Make sure it is a bug related to this project
+Before reporting the bug, please make sure that the bug is in the project and not from your own code or any other library used.
+
+### Try the latest version
+Bugs in the older versions of the project may have already been fixed. 
+In order to avoid reporting known issues, make sure you are always testing against the latest release. 
+Also make sure the problem hasn't already been reported on the [GitHub Issues Tracker](https://github.com/techlab/SmartWizard/issues/). 
+If not, create a new issue there and include your test case.
+
+### Notes for pull request
+- Follow the same code style as the library.
+- Run the test suites in the `test` directory first by running `npm test` or `gulp test`.
+- Don't modify any files in the `dist` directory.

karma.conf.js

@@ -40,7 +40,7 @@ module.exports = function(config) {
     // test results reporter to use
     // possible values: 'dots', 'progress'
     // available reporters: https://npmjs.org/browse/keyword/karma-reporter
-    reporters: ['progress'],
+    reporters: ['spec'],
 
 
     // web server port

package.json

@@ -1,67 +1,68 @@
 {
-    "name": "smartwizard",
-    "version": "v4.2.1",
-    "author": "Dipu Raj <hello@techlaboratory.net>",
-    "description": "The awesome jQuery step wizard plugin with Bootstrap support",
-    "homepage": "http://techlaboratory.net/smartwizard",
-    "license": "MIT",
-    "contributors": [
-        {
-            "name": "Dipu Raj",
-            "email": "hello@techlaboratory.net"
-        }
-    ],
-    "main": "./js/jquery.smartWizard.js",
-    "style": "./css/smart_wizard.css",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/techlab/SmartWizard.git"
-    },
-    "bugs": {
-        "url": "https://github.com/techlab/SmartWizard/issues"
-    },
-    "keywords": [
-        "bootstrap",
-        "wizard",
-        "step",
-        "ui",
-        "jquery-plugin",
-        "tabs",
-        "jquery"
-    ],
-    "scripts": {
-        "start": "",
-        "test": "./node_modules/.bin/karma start --single-run --browsers PhantomJS",
-        "build": "gulp",
-        "clean": "gulp clean",
-        "lint": "gulp lint"
-    },
-    "dependencies": {
-        "jquery": ">=1.9.0",
-        "bootstrap": ">=3.0.0"
-    },
-    "devDependencies": {
-        "autoprefixer": "^6.7.7",
-        "del": "^2.2.2",
-        "gulp": "^3.9.1",
-        "gulp-babel": "^6.1.2",
-        "gulp-clean-css": "^3.0.4",
-        "gulp-cssbeautify": "^0.1.3",
-        "gulp-jasmine": "^2.4.2",
-        "gulp-jshint": "^2.0.4",
-        "gulp-karma": "0.0.5",
-        "gulp-postcss": "^6.4.0",
-        "gulp-rename": "^1.2.2",
-        "gulp-uglify": "^2.1.1",
-        "jasmine-core": "^2.5.2",
-        "jasmine-jquery": "^2.1.1",
-        "jshint": "^2.9.4",
-        "karma": "^1.5.0",
-        "karma-chrome-launcher": "^2.0.0",
-        "karma-cli": "^1.0.1",
-        "karma-jasmine": "^1.1.0",
-        "karma-jasmine-html-reporter": "^0.2.2",
-        "karma-jasmine-jquery": "^0.1.1",
-        "karma-phantomjs-launcher": "^1.0.4"       
+  "name": "smartwizard",
+  "version": "v4.2.1",
+  "author": "Dipu Raj <hello@techlaboratory.net>",
+  "description": "The awesome jQuery step wizard plugin with Bootstrap support",
+  "homepage": "http://techlaboratory.net/smartwizard",
+  "license": "MIT",
+  "contributors": [
+    {
+      "name": "Dipu Raj",
+      "email": "hello@techlaboratory.net"
     }
-}
+  ],
+  "main": "./js/jquery.smartWizard.js",
+  "style": "./css/smart_wizard.css",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/techlab/SmartWizard.git"
+  },
+  "bugs": {
+    "url": "https://github.com/techlab/SmartWizard/issues"
+  },
+  "keywords": [
+    "bootstrap",
+    "wizard",
+    "step",
+    "ui",
+    "jquery-plugin",
+    "tabs",
+    "jquery"
+  ],
+  "scripts": {
+    "start": "",
+    "test": "./node_modules/.bin/karma start --single-run --browsers PhantomJS",
+    "build": "gulp",
+    "clean": "gulp clean",
+    "lint": "gulp lint"
+  },
+  "dependencies": {
+    "jquery": ">=1.9.0",
+    "bootstrap": ">=3.0.0"
+  },
+  "devDependencies": {
+    "autoprefixer": "^6.7.7",
+    "del": "^2.2.2",
+    "gulp": "^3.9.1",
+    "gulp-babel": "^6.1.2",
+    "gulp-clean-css": "^3.0.4",
+    "gulp-cssbeautify": "^0.1.3",
+    "gulp-jasmine": "^2.4.2",
+    "gulp-jshint": "^2.0.4",
+    "gulp-karma": "0.0.5",
+    "gulp-postcss": "^6.4.0",
+    "gulp-rename": "^1.2.2",
+    "gulp-uglify": "^2.1.1",
+    "jasmine-core": "^2.5.2",
+    "jasmine-jquery": "^2.1.1",
+    "jshint": "^2.9.4",
+    "karma": "^1.5.0",
+    "karma-chrome-launcher": "^2.0.0",
+    "karma-cli": "^1.0.1",
+    "karma-jasmine": "^1.1.0",
+    "karma-jasmine-html-reporter": "^0.2.2",
+    "karma-jasmine-jquery": "^0.1.1",
+    "karma-phantomjs-launcher": "^1.0.4",
+    "karma-spec-reporter": "0.0.31"
+  }
+}