Permalink
Browse files

update contributing guidelines

  • Loading branch information...
1 parent f2c485e commit abb3245590fdf97a8e7f471f41679d11023e0fd0 @makeusabrew committed Oct 1, 2013
Showing with 17 additions and 6 deletions.
  1. +6 −5 CONTRIBUTING.md
  2. +9 −0 Gruntfile.js
  3. +2 −1 package.json
View
@@ -1,11 +1,12 @@
## Submitting Pull Requests
-* run ```npm install``` to make sure your development dependencies are up-to-date
-* Please ensure that the test suite passes before submitting a PR:
- * ```npm test```
+* Please rebase your branch against the current master
+* Run ```npm install``` to make sure your development dependencies are up-to-date
+* [grunt-cli](https://github.com/gruntjs/grunt-cli) >= 0.4.0 is required to sanity check your contribution
+* Please ensure that the test suite passes **and** that bootbox.js is lint free before submitting a PR:
+ * ```grunt```
* If you've added new functionality, **please** include tests which validate its behaviour
-* Please ensure that bootbox.js is lint free:
- * ```grunt jshint```
+* **Please follow these basic steps to make pull request reviews easier!**
## Submitting bug reports
View
@@ -16,9 +16,18 @@ module.exports = function(grunt) {
jshintrc: ".jshintrc"
},
all: ["bootbox.js"]
+ },
+
+ karma: {
+ unit: {
+ configFile: "karma.conf.js"
+ }
}
});
grunt.loadNpmTasks("grunt-contrib-uglify");
grunt.loadNpmTasks("grunt-contrib-jshint");
+ grunt.loadNpmTasks("grunt-karma");
+
+ grunt.registerTask("default", ["jshint", "karma"]);
};
View
@@ -28,6 +28,7 @@
"karma-junit-reporter": "~0.1.0",
"sinon": "~1.7.3",
"sinon-chai": "~2.4.0",
- "karma-chai": "0.0.1"
+ "karma-chai": "0.0.1",
+ "grunt-karma": "~0.6.2"
}
}

0 comments on commit abb3245

Please sign in to comment.