forked from fabien-d/alertify.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing
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.
- Fork and clone the repo.
- Check out the master branch
- Run
npm installto install all Grunt dependencies. - Run
grunt(same asgrunt build)
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.
- Whitespace: 4 space indentation
- 1 space between function brackets and operators
function (a, b) {},if (condition) {},var x = a - b
- Quotes: Double quotes
- Develop in a topic branch (not master)
- Write failing test, run
grunt testto ensure it fails - Write code to fix failing test
- run
grunt testrepeat step 2-4 as needed - Submit pull request