Skip to content
fabien-d edited this page Feb 18, 2013 · 2 revisions

0.4. documentation, see 0.3.* documentation*

Awesome, you'd like to contribute to alertify.js. Before you get started, make sure you've read the installing alertify.js.

Basics (from installing alertify.js)

  1. Fork and clone the repo.
  2. Check out the master branch
  3. Run npm install to install all Grunt dependencies.
  4. Run grunt (same as grunt build)

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.

Project Specific

  1. Whitespace: 4 space indentation
  • 1 space between function brackets and operators function (a, b) {}, if (condition) {}, var x = a - b
  1. Quotes: Double quotes

Pull Request Guidelines

  1. Develop in a topic branch (not master)
  2. Write failing test, run grunt test to ensure it fails
  3. Write code to fix failing test
  4. run grunt test repeat step 2-4 as needed
  5. Submit pull request

Clone this wiki locally