Skip to content

Commit d762d58

Browse files
committed
Update CONTRIBUTING.md
1 parent 38d74b5 commit d762d58

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
1+
# Asking for help and features
2+
Though I am really happy to provide help, I am not your mom nor your instructor. Any request without enough detail and any bug report without a code example (live example is preferred) won't get any answer.
3+
4+
Be exhaustive, describe your needs, show what you tried, it's the best way to get a rapid answer/bug fix.
5+
16
# How to contribute
27

3-
## Core vs Modules
4-
I want to keep the core clean of extra (and certainly awesome) functionalities. That includes, but is not limited to, export/import modules, visual aids, etc.
8+
## Core vs Plugins
9+
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.
10+
11+
Check the doc about [creating plugins](http://mistic100.github.io/jQuery-QueryBuilder/dev/plugins.html).
512

6-
Check to doc about [creating plugins](http://mistic100.github.io/jQuery-QueryBuilder/dev/plugins.html)
13+
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 intergated 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.
714

815
## Unit tests
916
Any big feature must have it's own QUnit tests suite. Of course existing tests must still pass after changes.
@@ -13,5 +20,5 @@ I won't merge any branch not passing the TravisCI build (this include JShint com
1320
## dist files
1421
Keep it simple, don't commit any files in the `dist` directory, I build these files only before a release.
1522

16-
## Translation
17-
Source language files are plain JSON files which will be converted to executable JS files by the build task. The `__copyright` key can be used to give information about the translator.
23+
## Translations
24+
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.

0 commit comments

Comments
 (0)