Skip to content

Commit 057de03

Browse files
committed
Add CONTRIBUTING.md #64.
Other grunt/CI task fixes.
1 parent 94c57b0 commit 057de03

File tree

4 files changed

+26
-12
lines changed

4 files changed

+26
-12
lines changed

.travis.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ before_script:
1010
- export DISPLAY=:99.0
1111
- sh -e /etc/init.d/xvfb start
1212
script:
13-
- grunt ci
13+
- npm test
14+
- grunt coveralls || true

CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing Guide
2+
3+
First, feel free to contact me with questions
4+
5+
1. Fork the repo
6+
- `$ git clone <yourForkUrl>`
7+
- `$ npm install && bower install && npm test`
8+
1. Checkout a new branch based on whatever version branch is available (if none then branch from `master`) and name it to what you intend to do:
9+
- `$ git checkout -b BRANCH_NAME`
10+
- Use one branch per fix/feature
11+
1. Make your changes
12+
- Use `grunt build`, `grunt watch` and `grunt karma:dev` while developing
13+
- Make sure to provide a spec for unit tests
14+
- Run your tests with `test`
15+
- When all tests pass, everything's fine
16+
1. Commit your changes
17+
- Please provide a git message which explains what you've done
18+
- Commit to the forked repository
19+
1. Make a pull request
20+
- Make sure you send the PR to the branch you branched from
21+
- Travis CI is watching you!

Gruntfile.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ module.exports = function (grunt) {
382382
grunt.file.write('dist/angular-data.js', file);
383383
});
384384

385-
grunt.registerTask('test', ['clean:coverage', 'karma:dev']);
385+
grunt.registerTask('test', ['build', 'karma:ci', 'karma:cacheFactory', 'karma:min']);
386386
grunt.registerTask('doc', ['clean:doc', 'docular', 'concat', 'copy', 'clean:afterDoc', 'uglify:scripts']);
387387
grunt.registerTask('build', [
388388
'clean',
@@ -395,5 +395,5 @@ module.exports = function (grunt) {
395395
grunt.registerTask('default', ['build']);
396396

397397
// Used by TravisCI
398-
grunt.registerTask('ci', ['build', 'karma:ci', 'karma:cacheFactory', 'karma:min', 'coveralls', 'doc']);
398+
grunt.registerTask('ci', ['test', 'doc']);
399399
};

README.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,7 @@ Roadmap:
3131

3232
[Design Doc](https://docs.google.com/document/d/1o069KLuBH4jpwm1FCLZFwKMgM73Xi8_1JyjhSxVpidM/edit?usp=sharing) - Design document for Angular-data.
3333

34-
#### Contributing
35-
1. Fork the repo
36-
1. `$ git clone {{yourForkUrl}}`
37-
1. `$ npm install && bower install && npm test`
38-
1. Make your changes complete with any applicable tests
39-
1. `$ npm test` (make sure they pass ;-D)
40-
1. `$ git commit -am 'A useful commit message'`
41-
1. `$ git push`
42-
1. Create PR :-D Thanks!
34+
[Contributing Guide](https://github.com/jmdobry/angular-data/blob/master/CONTRIBUTING.md)
4335

4436
## Project Status
4537

0 commit comments

Comments
 (0)