diff --git a/Gruntfile.js b/Gruntfile.js deleted file mode 100644 index 530074150e..0000000000 --- a/Gruntfile.js +++ /dev/null @@ -1,48 +0,0 @@ -'use strict'; - -module.exports = function (grunt) { - - // Project configuration. - grunt.initConfig({ - pkg: grunt.file.readJSON('package.json'), - release: {}, - jshint: { - options: { - jshintrc: '.jshintrc' - }, - lib: ['lib/**/*.js', 'Gruntfile.js'], - test: 'test/**/*.js' - }, - jsbeautifier: { - options: { - js: { - indent_size: 2, - jslintHappy: true, - keepArrayIndentation: true, - wrapLineLength: 0 - } - }, - files: ['lib/**/*.js', 'test/**/*.js', 'Gruntfile.js', 'package.json'] - }, - simplemocha: { - application: { - src: ['test/application.test.js'] - }, - mixins: { - src: ['test/mixins/**/*.test.js'] - }, - providers: { - src: ['test/providers/**/*.test.js'] - } - } - }); - - grunt.loadNpmTasks('grunt-contrib-jshint'); - grunt.loadNpmTasks('grunt-release'); - grunt.loadNpmTasks('grunt-jsbeautifier'); - grunt.loadNpmTasks('grunt-simple-mocha'); - - grunt.registerTask('test', 'simplemocha'); - grunt.registerTask('beautify', 'jsbeautifier'); - grunt.registerTask('default', ['jshint', 'simplemocha']); -}; diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000000..247b5937dc --- /dev/null +++ b/contributing.md @@ -0,0 +1,35 @@ +# Contributing to Feathers + +Thank you for contributing to Feathers! + +## Report a bug + +Issues can be reported in the [issue tracker](https://github.com/feathersjs/feathers/issues) or the [Gitter chat](https://gitter.im/feathersjs/feathers). + +If you have any other questions, feel free to submit post them on [Stackoverflow](http://stackoverflow.com) using the `feathers` or `feathersjs` tag or join [#feathersjs](http://webchat.freenode.net/?channels=feathersjs) on Freenode IRC. + +## Code style + +Before running the tests from the `test/` folder `npm test` will run JSHint. You can check your code changes individually by running `npm run jshint`. + +## Tests + +[Mocha](http://mochajs.org/) tests are located in the `test/` folder and can be run using the `npm run mocha` or `npm test` (with JSHint) command. + +## Documentation + +Feathers documentation is currently contained in Markdown files in the [gh-pages branch](https://github.com/feathersjs/feathers/tree/gh-pages). To change the documentation submit a pull request against that branch and the documentation will be automatically updated using Jekyll. + +# Contributor Code of Conduct + +As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. + +Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/) diff --git a/license.md b/license.md index 41bd7406a9..ed4e3bcba2 100644 --- a/license.md +++ b/license.md @@ -1,7 +1,6 @@ ## MIT License -Copyright (C) 2014 David Luecke daff@neyeon.com -Copyright (C) 2014 Eric Kryski e.kryski@gmail.com +Copyright (C) 2015 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/package.json b/package.json index bc248c26ad..b78812050b 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,13 @@ "lib": "lib" }, "scripts": { - "test": "grunt --stack" + "publish": "git push origin --tags", + "release:patch": "npm version patch && npm publish", + "release:minor": "npm version minor && npm publish", + "release:major": "npm version major && npm publish", + "jshint": "jshint lib/. test/. --config", + "mocha": "mocha test/ --recursive", + "test": "npm run jshint && npm run mocha" }, "engines": { "node": ">= 0.10.0", @@ -47,13 +53,8 @@ "uberproto": "^1.1.0" }, "devDependencies": { - "grunt": "^0.4.0", - "grunt-cli": "^0.1.0", - "grunt-contrib-jshint": "^0.x", - "grunt-jsbeautifier": "^0.2.0", - "grunt-release": "^0.7.0", - "grunt-simple-mocha": "^0.4.0", - "mocha": "^1.x", + "jshint": "^2.6.3", + "mocha": "^2.2.0", "q": "^1.0.1", "request": "^2.x", "socket.io-client": "^1.0.0",