Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.26 KB

CONTRIBUTING.markdown

File metadata and controls

33 lines (21 loc) · 1.26 KB

Contributing to Chained

Only one feature or change per pull request

Make pull requests only one feature or change at the time. For example you have fixed a bug. You also have optimized some code. Optimization is not related to a bug. These should be submitted as separate pull requests. This way I can easily choose what to include. It is also easier to understand the code changes. Commit messages should be descriptive and full sentences.

Do not commit minified versions. Do not touch the version number. Make the pull requests againts 0.9.x branch

Follow the existing coding standards

When contributing to open source project it is polite to follow the original authors coding standars. They might be different than yours. It is not a holy war. Just follow then original.

var snake_case = "something";

function camelCase(options) {
}

if (true !== false) {
    console.log("here be dragons");
}

Make sure tests pass

After you change some code make sure all the test still pass. You can run tests from the commandline with the following:

npm install
grunt test

Or you can also open the test runner in browser.