Skip to content

Commit

Permalink
added "Conventions" section. Issue cdnjs#652
Browse files Browse the repository at this point in the history
  • Loading branch information
Lockyc committed Jul 16, 2013
1 parent a776142 commit 9b70597
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<a href="http://travis-ci.org/cdnjs/cdnjs"><img src="https://secure.travis-ci.org/cdnjs/cdnjs.png" alt="Build Status" style="max-width:100%;"></a>


# cdnJS Script Repository

The repository mirroring all scripts on cdnjs.cloudflare.com, created and maintained by [Thomas Davis](https://twitter.com/neutralthoughts), [Ryan Kirkman](https://twitter.com/ryan_kirkman) and [Lachlan Collins](http://plus.google.com/116251728973496544370?prsrc=3)
Expand All @@ -12,6 +11,12 @@ __Libraries must have notable popularity. 100 watchers on GitHub is a good examp

[Extensions, Plugins, Resources](https://github.com/cdnjs/cdnjs/wiki/Extensions%2C-Plugins%2C-Resources)

## Conventions

* Filenames should **not** include version number and be **lowercase**
* Javascript & Css files should be minified, If the library doesn't already provide a minified version, our preferred minifier is [UglifyJS](http://marijnhaverbeke.nl/uglifyjs "UglifyJS")
* If updating an existing library, try to keep consistant with the existing structure

## Pull requests steps

1. Fork this repository
Expand All @@ -32,5 +37,3 @@ __Libraries must have notable popularity. 100 watchers on GitHub is a good examp
## Running the validator
1. Install all the needed dependencies locally (you will need `node`): `npm install`
2. Run the test suite: `npm test`


0 comments on commit 9b70597

Please sign in to comment.