Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 976 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 976 Bytes

Contributing to MineStat

Issue Tracker

https://github.com/FragLand/minestat/issues

Discord

https://discord.frag.land/

Coding Convention

Please follow the existing styling as closely as possible for any code contributions. This will vary by programming language. Here are some general tips:

  • Make use of comments to document code when sensible.

  • Use spaces and not tabs.

  • Indent by 2 spaces.

  • Use Allman style for blocks (this is not applicable to Go unfortunately). For example:

    int func()
    {
      // ...
    }

    Rather than K&R style:

    int func() {
      // ...
    }
  • Constant names should typically be capitalized. For example:

    const double PI = 3.14159;
  • Variable and function names containing multiple words should be separated with an underscore _. Use PascalCase for C# method names and camelCase for Java method names. Also use camelCase for C# method parameters and local variables.