Contribute

We are always looking for more contributors and there are many ways you can help!

• Open an issue for a bug or a feature request
• Send us a message if you're using jmpress.js
• Add/update the test cases
• Fix a bug or write a feature then submit a pull request

Thank you for using and contributing to jmpress.js!

Edit & Build

Quickly

• Install Node.js and git.
• Install Grunt: npm install grunt-cli -g.
• Clone the jmpress.js repo: git clone git://github.com/jmpressjs/jmpress.js.git && cd jmpress.js.
• Run npm install to install the development dependencies.
• Finally run grunt to build.

Longer Build Explanation

All the source files are located in the src/ folder. They are broken up into components and plugins to allow users to build their own customized version of jmpress.js.

Grunt

We use the command line build tool: grunt. It requires Node.js. If you already have Node.js installed, navigate to your copy of jmpress.js and run the command: npm install to install any development dependencies. It is recommended to install the grunt command globally with npm install grunt-cli -g.

Then navigate to your copy of jmpress.js and run the command: grunt (windows: grunt.cmd) to build. You can also use the command grunt watch to continuously build jmpress.js as you edit.

The output files will be located in the dist/ folder. Please do not edit any file in this folders as they are automatically generated. You can delete them and they will be regenerated.

Testing

jmpress.js uses QUnit for testing. Please run /tests/ in your browser to run the tests or the command: grunt qunit.

Currently the tests need a lot of catching up. Any help you can provide will be very much appreciated.

Pull Requests

Good news! We accept pull requests!

Docs

If you find an error or something missing please edit and submit a pull request. There is an Edit This Page button on the bottom of each page or fork then clone the docs with git. Thank you for contributing!

Edit This Page