summaryrefslogtreecommitdiffstats
path: root/Contributing.md
diff options
context:
space:
mode:
authorMaxime Quandalle <maxime@quandalle.com>2015-05-12 19:20:58 +0200
committerMaxime Quandalle <maxime@quandalle.com>2015-05-12 19:33:50 +0200
commit2dbea30842ec63a68055245fe26633bb7913daf3 (patch)
treee9143893a3d3bf4ad34dd3a97d6f3466561c8756 /Contributing.md
downloadwekan-2dbea30842ec63a68055245fe26633bb7913daf3.tar.gz
wekan-2dbea30842ec63a68055245fe26633bb7913daf3.tar.bz2
wekan-2dbea30842ec63a68055245fe26633bb7913daf3.zip
Renaissance
_,,ad8888888888bba,_ ,ad88888I888888888888888ba, ,88888888I88888888888888888888a, ,d888888888I8888888888888888888888b, d88888PP"""" ""YY88888888888888888888b, ,d88"'__,,--------,,,,.;ZZZY8888888888888, ,8IIl'" ;;l"ZZZIII8888888888, ,I88l;' ;lZZZZZ888III8888888, ,II88Zl;. ;llZZZZZ888888I888888, ,II888Zl;. .;;;;;lllZZZ888888I8888b ,II8888Z;; `;;;;;''llZZ8888888I8888, II88888Z;' .;lZZZ8888888I888b II88888Z; _,aaa, .,aaaaa,__.l;llZZZ88888888I888 II88888IZZZZZZZZZ, .ZZZZZZZZZZZZZZ;llZZ88888888I888, II88888IZZ<'(@@>Z| |ZZZ<'(@@>ZZZZ;;llZZ888888888I88I ,II88888; `""" ;| |ZZ; `""" ;;llZ8888888888I888 II888888l `;; .;llZZ8888888888I888, ,II888888Z; ;;; .;;llZZZ8888888888I888I III888888Zl; .., `;; ,;;lllZZZ88888888888I888 II88888888Z;;...;(_ _) ,;;;llZZZZ88888888888I888, II88888888Zl;;;;;' `--'Z;. .,;;;;llZZZZ88888888888I888b ]I888888888Z;;;;' ";llllll;..;;;lllZZZZ88888888888I8888, II888888888Zl.;;"Y88bd888P";;,..;lllZZZZZ88888888888I8888I II8888888888Zl;.; `"PPP";;;,..;lllZZZZZZZ88888888888I88888 II888888888888Zl;;. `;;;l;;;;lllZZZZZZZZW88888888888I88888 `II8888888888888Zl;. ,;;lllZZZZZZZZWMZ88888888888I88888 II8888888888888888ZbaalllZZZZZZZZZWWMZZZ8888888888I888888, `II88888888888888888b"WWZZZZZWWWMMZZZZZZI888888888I888888b `II88888888888888888;ZZMMMMMMZZZZZZZZllI888888888I8888888 `II8888888888888888 `;lZZZZZZZZZZZlllll888888888I8888888, II8888888888888888, `;lllZZZZllllll;;.Y88888888I8888888b, ,II8888888888888888b .;;lllllll;;;.;..88888888I88888888b, II888888888888888PZI;. .`;;;.;;;..; ...88888888I8888888888, II888888888888PZ;;';;. ;. .;. .;. .. Y8888888I88888888888b, ,II888888888PZ;;' `8888888I8888888888888b, II888888888' 888888I8888888888888888 ,II888888888 ,888888I8888888888888888 ,d88888888888 d888888I8888888888ZZZZZZ ,ad888888888888I 8888888I8888ZZZZZZZZZZZZ 888888888888888' 888888IZZZZZZZZZZZZZZZZZ 8888888888P'8P' Y888ZZZZZZZZZZZZZZZZZZZZ 888888888, " ,ZZZZZZZZZZZZZZZZZZZZZZZ 8888888888, ,ZZZZZZZZZZZZZZZZZZZZZZZZZZ 888888888888a, _ ,ZZZZZZZZZZZZZZZZZZZZ88888888 888888888888888ba,_d' ,ZZZZZZZZZZZZZZZZZ8888888888888 8888888888888888888888bbbaaa,,,______,ZZZZZZZZZZZZZZZ88888888888888888 88888888888888888888888888888888888ZZZZZZZZZZZZZZZ88888888888888888888 8888888888888888888888888888888888ZZZZZZZZZZZZZZ8888888888888888888888 888888888888888888888888888888888ZZZZZZZZZZZZZZ88888888888888888888888 8888888888888888888888888888888ZZZZZZZZZZZZZZ8888888888888888888888888 88888888888888888888888888888ZZZZZZZZZZZZZZ888888888888888888888888888 8888888888888888888888888888ZZZZZZZZZZZZZZ88888888888888888 Normand 8 88888888888888888888888888ZZZZZZZZZZZZZZ8888888888888888888 Veilleux 8 8888888888888888888888888ZZZZZZZZZZZZZZ8888888888888888888888888888888
Diffstat (limited to 'Contributing.md')
-rw-r--r--Contributing.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/Contributing.md b/Contributing.md
new file mode 100644
index 00000000..cfd67216
--- /dev/null
+++ b/Contributing.md
@@ -0,0 +1,57 @@
+# Contributing
+
+We’re glad you’re interested in helping the LibreBoard project! We welcome bug
+reports, enhancement ideas, and pull requests, in our GitHub bug tracker. Before
+opening a new thread please verify that your issue hasn’t already been reported.
+
+<https://github.com/libreboard/libreboard>
+
+## Translations
+
+You are encouraged to translate (or improve the translation of) LibreBoard in
+your locale language. For that purpose we rely on
+[Transifex](https://www.transifex.com/projects/p/libreboard). So the first step
+is to create a Transifex account if you don’t have one already. You can then
+send a request to join one of the translation teams. If there we will create a
+new one.
+
+Once you are in a team you can start translating the application. Please take a
+look at the glossary so you can agree with other (present and future)
+contributors on words to use to translate key concepts in the application like
+“boards” and “cards”.
+
+The original application is written in English, and if you want to contribute to
+the application itself, you are asked to fill the `i18n/en.i18n.json` file. When
+you do that the new strings of text to translate automatically appears on
+Transifex to be translated (the refresh may take a few hours).
+
+We pull all translations from Transifex before every new LibreBoard release
+candidate, ask the translators to review the app, and pull all translations
+again for the final release.
+
+## Installation
+
+LibreBoard is made with [Meteor](https://www.meteor.com). Thus the easiest way
+to start hacking is by installing the framework, cloning the git repository, and
+launching the application:
+
+```bash
+$ curl https://install.meteor.com/ | sh # On Mac or Linux
+$ git clone https://github.com/libreboard/libreboard.git
+$ cd libreboard
+$ meteor
+```
+
+As for any Meteor application, LibreBoard is automatically refreshed when you
+change any file of the source code, just play with it to see how it behaves!
+
+## Style guide
+
+We follow the
+[meteor style guide](https://github.com/meteor/meteor/wiki/Meteor-Style-Guide).
+
+Please read the meteor style guide before making any significant contribution.
+
+## Code organisation
+
+TODO