Skip to content

Commit 6bdbf5f

Browse files
jgollacoderifous
authored andcommitted
Markdown updates; packages.json updates
Updating contributing section of the read me. Updating contributing markdown to mention coffee script. Updating packages.json to remove unused packages.
1 parent 71e3c66 commit 6bdbf5f

File tree

3 files changed

+5
-19
lines changed

3 files changed

+5
-19
lines changed

CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing
22

33
## Important notes
4-
Please don't edit files in the `dist` subdirectory as they are generated via Grunt. You'll find source code in the `src` subdirectory!
4+
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/)
55

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

2122
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.
2223

@@ -28,4 +29,4 @@ Assuming that you don't see any red, you're ready to go. Just be sure to run `gr
2829
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
2930
1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
3031
1. Update the documentation to reflect any changes.
31-
1. Push to your fork and submit a pull request.
32+
1. Push to your fork and submit a pull request.

README.md

+1-14
Original file line numberDiff line numberDiff line change
@@ -163,20 +163,7 @@ See the test/samples for working examples.
163163

164164
# Contributing
165165

166-
This plugin is written in [CoffeeScript](http://jashkenas.github.com/coffee-script/).
167-
The included `builder` script will run `coffee` with the necessary flags to
168-
automatically update the compiled javascript in the build/ directory any time you
169-
save changes to the coffee code under src/.
170-
171-
If you're interested in contributing, please fork the [repository](https://github.com/coderifous/jquery-localize),
172-
make your changes, and send pull-requests.
173-
174-
Tests use QUnit. Run them by serving from the root of the project and
175-
navigating to the test/ directory, which has an index.html that takes it from
176-
there.
177-
178-
Learn more about [how to fork](http://help.github.com/fork-a-repo/) and
179-
[pull-requests](http://help.github.com/pull-requests/).
166+
To contribute to this plugin, please read the [contributing guidelines](CONTRIBUTING.md).
180167

181168
# Credits & Licensing
182169

package.json

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "jquery-plugin",
2+
"name": "jquery-localize",
33
"version": "0.0.0-ignored",
44
"engines": {
55
"node": ">= 0.8.0"
@@ -9,9 +9,7 @@
99
},
1010
"devDependencies": {
1111
"grunt-contrib-qunit": "~0.2.0",
12-
"grunt-contrib-concat": "~0.3.0",
1312
"grunt-contrib-uglify": "~0.2.0",
14-
"grunt-contrib-watch": "~0.4.0",
1513
"grunt-contrib-clean": "~0.4.0",
1614
"grunt": "~0.4.2",
1715
"grunt-contrib-coffee": "~0.10.0",

0 commit comments

Comments
 (0)