For developers and contributors
-
Fork project and clone your fork
-
Install global dependencies
npm install -g coffee-script
Note: You will need coffee-script for Docpad (v6). This plugin doesn't need it.
-
Install local dependencies
npm run our:setup
-
Compile project
npm run our:compile
-
Run tests
npm run our:test
For project maintainers
-
Update meta files with latest information
npm run our:release:prepare
-
Add a changelog entry to
HISTORY.mdwith change informationv2.0.0 April 17, 2013 - Something that changes -
Update
versionentry inpackage.jsonwith new version number -
Commit changes
git commit -a -m "A message about what changed" -
Publish new version
npm run our:release npm publish