Skip to content

Contribution

TheMHMoritz3 edited this page Feb 12, 2017 · 6 revisions

Contribution

You are free to contribute, to contribute you have to follow the following steps.

1. Create your own fork

You know how to Fork.

2. Happy Coding

Windows

You need Visual Studio, then you are able to open the Windows-Client.sln-file.

Linux

You need Monodovelop and then you are good to go. Only open in ./win32/Linux-Solution/ the Linux-Solution.sln-File.

3. Create a Pullrequest to our repository

Code Guidelines

Code Comments

We and you should use comment and descirbe our code like this:

/// <summary>
/// Some Summary
/// </summary>
public void yourMethodHere()

Naming Guidelines

Methods

Method names should start with an little character. Every word after the second should be written in the UpperCamelCase-Style.

For example methodName()

Properties

Properties should be written in UpperCamelCase-Style, with the starting letter as an huge letter. Like this:

String MyProperty
{
    get{...}
    set{...}
}

Varaibles

Private variables in classes should start with an underscore and then with an huge letter: string _Variable

Varaibles as parameter in methods should start with with a small letter: void foo(string moreFoo)

Global varaibles are not allowed, despite they are constant, then they are written all huge letters: const string FOO

All Variable naming should have in common, that they are like methodnames the next word is in UpperCamelCase-Style.

Hacking

Please stay in your Fork