Skip to content

Contributing

Fabien Doiron edited this page Mar 22, 2014 · 6 revisions

Basics (from installing alertify.js)

  1. Fork and clone the repo.
  2. Check out the branch for the version you wish to contribute to: 0.3, 0.4 (Deprecated), 0.5
  3. Run npm install to install all Grunt dependencies.
  4. Run grunt

Code Standards

The alertify.js coding standards are set for all code in the code-base to look like a single person wrote it. This is not to say my style preference is better than another, it's simply to keep the project consistent and easier to read.

Most of the code standards are based on idiomatic.js with a few minor overwrites/differences or project specifics. Simply follow the coding style in the version you are working on!

Pull Request Guidelines

  1. Develop in a topic branch (not master)
  2. Ensure you write tests for new functionality
  3. Squash your commits
  4. Submit pull request