Toc toolToc tool

Contribution

Table of Contents

Introduction

You are encouraged to contribute to Node.js PAD. Node.js PAD is an open source project hosted on GitHub originally written by Adaltas.

Contributions go far beyond pull requests and commits. we are thrilled to receive a variety of other contributions including the following:

  • Write and publish your own actions
  • Write articles and blog posts, create tutorial and spread the words
  • Submit new ideas of features and documentation
  • Submitting documentation updates, enhancements, designs, or bugfixes
  • Submitting spelling or grammar fixes
  • Additional unit or functional tests
  • Help answering questions and issues on GitHub

Development

Tests are executed with mocha. To install it, simple run npm install followed by npm test. It will install mocha and its dependencies in your project "node_modules" directory and run the test suite. The tests run against the CoffeeScript source files.

To generate the JavaScript files, run npm run build.

The test suite is run online with Travis against the versions 0.10 and 0.11 of Node.js.

Testing

Clone the repo, install the development dependencies and run the suite:

git clone http://github.com/wdavidw/node-pad.git
npm install
npm run test

Bugs

Where to Find Known Issues We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.

Contributors

Bellow is a non-restrictive list of contributors:

Please create an issue if you feel you deserve to be part of it.