the-djmaze/snappymail
1
1
Fork 0
mirror of https://github.com/the-djmaze/snappymail.git synced 2025-01-04 14:02:17 +08:00
Code Issues Projects Releases Packages Wiki Activity
snappymail/vendors/jquery-cookie/CONTRIBUTING.md
RainLoop Team 4cc2207513 Uploading and preparing the repository to the dev version. 
Original unminified source code (dev folder - js, css, less) (fixes #6)
Grunt build system
Multiple identities correction (fixes #9)
Compose html editor (fixes #12)
New general settings - Loading Description
New warning about default admin password
Split general and login screen settings
2013-11-16 02:21:12 +04:00

1.5 KiB
Raw Blame History

##Issues

##Pull requests

  • Create a new topic branch for every separate change you make.
  • Create a test case if you are fixing a bug or implementing an important feature.
  • Make sure the build runs successfully.

Development

###Tools We use the following tools for development:

  • Qunit for tests.
  • NodeJS required to run grunt and the test server only.
  • Grunt for task management.

###Getting started Install NodeJS.
Install globally grunt-cli using the following command:

$ npm install -g grunt-cli

Browse to the project root directory and install the dev dependencies:

$ npm install -d

To execute the build and tests run the following command in the root of the project:

$ grunt

You should see a green message in the console:

Done, without errors.

###Tests You can also run the tests in the browser.
Start a test server from the project root:

$ node test/server.js

Open the following URL in a browser:

$ open http://0.0.0.0:8124/test/index.html

Note: we recommend cleaning all the browser cookies before running the tests, that can avoid false positive failures.

###Automatic build You can build automatically after a file change using the following command:

$ grunt watch