Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added .jshintrtc, .editorconfig, AUTHORS, .gitattributes & Contributi…

…ng information, moved changelog to own file
  • Loading branch information...
commit 8363dafb19cd799d2e932dc37f71a0be46481d09 1 parent 8cab185
@asciidisco authored
View
10 .editorconfig
@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
View
1  .gitattributes
@@ -0,0 +1 @@
+* text=auto
View
14 .jshintrtc
@@ -0,0 +1,14 @@
+{
+ "curly": true,
+ "eqeqeq": true,
+ "immed": true,
+ "latedef": true,
+ "newcap": true,
+ "noarg": true,
+ "sub": true,
+ "undef": true,
+ "boss": true,
+ "eqnull": true,
+ "node": true,
+ "es5": true
+}
View
8 .npmignore
@@ -1,2 +1,6 @@
-/node_modules/
-.DS_Store
+.npmignore
+.editorconfig
+.gitattributes
+.travis.yml
+test
+Grunfile.js
View
1  AUTHORS.md
@@ -0,0 +1 @@
+Sebastian Golasch (http://github.com/asciidisco)
View
14 CHANGELOG
@@ -0,0 +1,14 @@
+v0.1.2:
+ date: 2012-11-22
+ changes:
+ - Fixed filename reference in package.json
+
+v0.1.1:
+ date: 2012-11-22
+ changes:
+ - ´include´ definition is now case insensitive
+
+v0.1.0:
+ date: 2012-11-22
+ changes:
+ - Initial release.
View
42 CONTRIBUTING.md
@@ -0,0 +1,42 @@
+# Contributing to grunt-backbonebuilder
+
+## Filing issues
+If something isn't working like you think it should, please read the documentation first.
+
+The best way to ensure an issue gets addressed is to file it in the appropriate issues tracker.
+
+### Simplify the issue
+Try to [reduce your code](http://www.webkit.org/quality/reduction.html) to the bare minimum required to reproduce the issue. This makes it much easier (and much faster) to isolate and fix the issue.
+
+### Explain the issue
+If we can't reproduce the issue, we can't fix it. Please list the exact steps required to reproduce the issue. Include versions of your OS, Node.js, grunt, etc. Include relevant logs or sample code.
+
+## Modifying grunt-backbonebuilder
+First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
+
+1. Fork and clone the repo.
+2. Check out the correct branch. Currently, the development happens in the `devel` branch.
+3. Run `npm install` to install all grunt-backbonebuilder dependencies.
+4. Run `grunt travis` to test & lint the plugin.
+
+Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing breaks.
+
+### Submitting pull requests
+
+1. Create a new branch, please don't work in your `master` or `devel` branch directly.
+2. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
+3. Fix stuff.
+4. Run `grunt travis` to see if the tests pass. Repeat steps 2-4 until done.
+5. Update the documentation to reflect any changes.
+6. Push to your fork and submit a pull request.
+
+### Syntax
+
+* Two space indents. Don't use tabs anywhere. Use `\t` if you need a tab character in a string.
+* No trailing whitespace, except in markdown files where a linebreak must be forced.
+* Don't go overboard with the whitespace.
+* No more than [one assignment](http://benalman.com/news/2012/05/multiple-var-statements-javascript/) per `var` statement.
+* Delimit strings with single-quotes `'`, not double-quotes `"`.
+* Prefer `if` and `else` to ["clever"](http://programmers.stackexchange.com/a/25281) uses of `? :` conditional or `||`, `&&` logical operators.
+* Comments are great. Just put them _before_ the line of code, _not_ at the _end_ of the line.
+* **When in doubt, follow the conventions you see used in the source already.**
View
13 README.md
@@ -28,7 +28,6 @@ configuration to your grunt file:
Example backbonebuilder grunt file config entry:
```javascript
-// ... grunt file contents
backbone: {
// the parts you want to include in your build
// possible values ['Model', 'Collection', 'View', 'Events', 'Router']
@@ -38,20 +37,12 @@ Example backbonebuilder grunt file config entry:
// if you want to use a different backbone version than the build in one (0.9.2)
// then just add a reference to your own UNMINIFIED backbone version
src: 'vendor/mySpecialBackboneVersion.js'
- },
-// ... even more grunt file contents
+ }
```
## Release History
+Take a look at the [Changelog](https://github.com/asciidisco/grunt-backbonebuilder/CHANGELOG)
-### 0.1.2
-+ Fixed filename reference in package.json
-
-### 0.1.1
-+ Include definition is now case insensitive
-
-### 0.1.0
-+ Initial Release
## License
Copyright (c) 2012 asciidisco
Please sign in to comment.
Something went wrong with that request. Please try again.