Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

73 lines (46 loc) · 1.14 KB

Contribute

Resources

Development

For developers and contributors

  1. Fork project and clone your fork

  2. Install global dependencies

    npm install -g coffee-script

    Note: You will need coffee-script for Docpad (v6). This plugin doesn't need it.

  3. Install local dependencies

    npm run our:setup
  4. Compile project

    npm run our:compile
  5. Run tests

    npm run our:test

Publishing

For project maintainers

  1. Update meta files with latest information

    npm run our:release:prepare
  2. Add a changelog entry to HISTORY.md with change information

    v2.0.0 April 17, 2013
    	- Something that changes
    
  3. Update version entry in package.json with new version number

  4. Commit changes

    git commit -a -m "A message about what changed"
  5. Publish new version

    npm run our:release
    npm publish