How to contribute to Upsilon

Hey, you have installed Upsilon and you want to contribute to its developpement ? It's very cool ! But if you want to be merged in Upsilon, you must respect some (simples) rules.

Respect Upsilon code-style

You may notice that the Upsilon code is written in a certain way:

• Variables are prefixed with m_, k_ or s_ depending on whether they belong to a class, are constant, or static
• Variables are written in camel case
• The opening braces are on the line of the declaration (ex: if (true) {)
• There is a space between the keyword if and the open parenthesis
• An indentation level corresponds to two spaces
• The files end with a line break
• Etc...

So when you are writing code for Upsilon you MUST respect this conventions.

---

Do all translations

It is not the job of the reviewers to do it.

---

Keep things clear and simple

Please use explicit variables names, even if it's more long. Before submitting your changes, you should make sure that there is no trash code that you have used for experimental purposes.

If your code is not explicit, comment it out (in english of course). Reviewers need to understand your code at first glance.

---

Use working things

Upsilon is a huge code base. If you want to add something to it, don't try to reinvent the wheel. In most cases, you just want to add a feature somewhere else, so take inspiration from how Upsilon already works elsewhere.