Skip to content

Commit 9b70597

Browse files
committed
added "Conventions" section. Issue cdnjs#652
1 parent a776142 commit 9b70597

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<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>
22

3-
43
# cdnJS Script Repository
54

65
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)
@@ -12,6 +11,12 @@ __Libraries must have notable popularity. 100 watchers on GitHub is a good examp
1211

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

14+
## Conventions
15+
16+
* Filenames should **not** include version number and be **lowercase**
17+
* 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")
18+
* If updating an existing library, try to keep consistant with the existing structure
19+
1520
## Pull requests steps
1621

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

0 commit comments

Comments
 (0)