• Jump To … +
    CONTRIBUTING.md MIT-LICENSE.md README.js.md audio.js audio/null_sound.js audio/sound.js audio/sound_instance.js core.js graphics.js graphics/animation.js graphics/canvas.js graphics/image.js graphics/sprite.js graphics/sprite_sheet.js keyboard.js media.js mouse.js timer.js timer/after.js timer/every.js timer/tween.js touch.js
  • ¶

    Contributing

    Dependencies & tools

    The original source is inside the src folder. It needs to be assembled into luv.js and luv.min.js. In order to do that:

    1. Install node.js
    2. Install the top-level packages: npm install grunt-cli mocha-phantomjs docco -g
    3. Install the project dependencies cd /path/to/luv.js/folder && npm install
    4. Once done,
    5. grunt will build luv.js and execute the test suite
    6. grunt compile will just generate luv.js and luv.min.js from src, with no tests.
    7. grunt docs will generate the documentation.

    Sending changes

    1. Fork the project
    2. Create a branch for the issue/feature you want to fix
    3. Use concise git commits, for each important change you make
    4. Add tests for the new features/fixes, and make sure they pass
    5. When done, send a pull request.

    More information:

    • How to Fork a repo
    • Using pull requests