Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

21 lines (13 loc) · 1.41 KB

Guidelines for contributing

Work on dev

Any merge request should be created from and issued to the dev branch.

Do not add the dist files to your pull request. The directory is ignored for a reason: it is generated and pushed only when doing a release on master.

Core vs Plugins

I want to keep the core clean of extra (and certainly awesome) functionalities. That includes, but is not limited to, export/import plugins, visual aids, etc.

Check the doc about creating plugins and use events.

I reserve the right to refuse any plugin I think is not useful for many people. Particularly, only import/export plugins for mainstream data storages will be integrated in the main repository. Others should be in a separated repository. But it's totally possible to add a link to your repository in the documentation.

Unit tests

Any big feature must have it's own QUnit tests suite. Of course existing tests must still pass after changes.

I won't merge any branch not passing the TravisCI build, including JShint/JSCS/SCSSlint compliance.

Translations

Source language files are plain JSON files which will be converted to executable JS files by the build task. The __locale key must be filled with the international name of the language + 2-chars code and the __author key can be used to give information about the translator.