docs(contributing): add contributing section to readme

Also, lower-case changelog
janraasch · Jan 25, 2014 · 67d54a7 · 67d54a7
1 parent de9d8ff
commit 67d54a7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/CHANGELOG.md → changelog.md b/CHANGELOG.md → changelog.md
diff --git a/gulpfile.coffee b/gulpfile.coffee
@@ -25,10 +25,10 @@ gulp.task 'test', ['coffee'], ->
 gulp.task 'changelog', ->
     changelog = require 'conventional-changelog'
     changelog({
-        repository: 'https://github.com/janraasch/generator-gulpplugin-coffee'
+        repository: 'https://github.com/janraasch/coffeelint-use-strict'
         version: require('./package.json').version
     }, (err, log) ->
-        fs.writeFileSync 'CHANGELOG.md', log
+        fs.writeFileSync 'changelog.md', log
     )
 
 # test drive

diff --git a/readme.md b/readme.md
@@ -48,10 +48,15 @@ Default: `false`
 
 Require the `'use strict'` statement to be at the top of a file.
 
+## Contributing
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [gulp][gulp] and [npm-test](https://npmjs.org/doc/test.html). Plus, make sure to adhere to these [commit message conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w).
+
 ## License
 
 [MIT License](http://en.wikipedia.org/wiki/MIT_License) © [Jan Raasch](http://janraasch.com)
 
+[gulp]: http://gulpjs.com/
+
 [coffeelint]: http://www.coffeelint.org
 [coffeelint-api-doc]: http://www.coffeelint.org/#api
 [moz-strictmode-doc]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions_and_function_scope/Strict_mode?redirectlocale=en-US&redirectslug=JavaScript%2FReference%2FFunctions_and_function_scope%2FStrict_mode