Skip to content

Commit

Permalink
Markdown updates; packages.json updates
Browse files Browse the repository at this point in the history
Updating contributing section of the read me. Updating contributing
markdown to mention coffee script. Updating packages.json to remove
unused packages.
  • Loading branch information
jgolla authored and coderifous committed Feb 20, 2014
1 parent 71e3c66 commit 6bdbf5f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 19 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
@@ -1,7 +1,7 @@
# Contributing

## Important notes
Please don't edit files in the `dist` subdirectory as they are generated via Grunt. You'll find source code in the `src` subdirectory!
Please don't edit files in the `dist` subdirectory as they are generated via Grunt. You'll find source code in the `src` subdirectory! This plugin is written in [CoffeeScript](http://jashkenas.github.com/coffee-script/)

### Code style
Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
Expand All @@ -17,6 +17,7 @@ Test that Grunt's CLI is installed by running `grunt --version`. If the command
1. Fork and clone the repo.
1. Run `npm install` to install all dependencies (including Grunt).
1. Run `grunt` to grunt this project.
1. To run the tests only, `grunt test`.

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 is broken.

Expand All @@ -28,4 +29,4 @@ Assuming that you don't see any red, you're ready to go. Just be sure to run `gr
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
1. Update the documentation to reflect any changes.
1. Push to your fork and submit a pull request.
1. Push to your fork and submit a pull request.
15 changes: 1 addition & 14 deletions README.md
Expand Up @@ -163,20 +163,7 @@ See the test/samples for working examples.

# Contributing

This plugin is written in [CoffeeScript](http://jashkenas.github.com/coffee-script/).
The included `builder` script will run `coffee` with the necessary flags to
automatically update the compiled javascript in the build/ directory any time you
save changes to the coffee code under src/.

If you're interested in contributing, please fork the [repository](https://github.com/coderifous/jquery-localize),
make your changes, and send pull-requests.

Tests use QUnit. Run them by serving from the root of the project and
navigating to the test/ directory, which has an index.html that takes it from
there.

Learn more about [how to fork](http://help.github.com/fork-a-repo/) and
[pull-requests](http://help.github.com/pull-requests/).
To contribute to this plugin, please read the [contributing guidelines](CONTRIBUTING.md).

# Credits & Licensing

Expand Down
4 changes: 1 addition & 3 deletions package.json
@@ -1,5 +1,5 @@
{
"name": "jquery-plugin",
"name": "jquery-localize",
"version": "0.0.0-ignored",
"engines": {
"node": ">= 0.8.0"
Expand All @@ -9,9 +9,7 @@
},
"devDependencies": {
"grunt-contrib-qunit": "~0.2.0",
"grunt-contrib-concat": "~0.3.0",
"grunt-contrib-uglify": "~0.2.0",
"grunt-contrib-watch": "~0.4.0",
"grunt-contrib-clean": "~0.4.0",
"grunt": "~0.4.2",
"grunt-contrib-coffee": "~0.10.0",
Expand Down

0 comments on commit 6bdbf5f

Please sign in to comment.