Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 2.15 KB

Contributing Guidelines

Hi i see you are looking to contribute which is great, we are looking foward with what ideas you have to make the Betelgeuse Star System better. Before you start contributing please read each section below. After the best way to contribute is to fork and start contributing.

Submitting Issues

Submitting issues will help us identify problems with our code. Before you submit an issue please read our the Issue Template. It is imparitive that you follow that template so we can attend to issues quickly, a well formed issue equals a well formed fix. You can sumit your issues here.

Submitting Changes

Please push a GitHub Pull Request with a clear description of what is being changed and why. (read more about pull requests). When you send a pull request, we expect that each commit has a clear explanation of what was done. If the coding standards are not followed we will request changes and once fixed we will consider the pull request.

Coding Standards

Make sure you follow the correct coding standards, makes our code more readable.

  • We indent using four spaces (use spacebar).
  • Namespaces needs an empty line before and after its declaration.
  • All classes have to start with a capital letter and followed by lower case characters, never use _.
  • The code in each function the exponents need to stay on the same line as an if, foreach, and other statements.
  • After declaring a class there needs to be an empty line at the beginning of the class, unless there are no method or variables.
  • You always declare public class variables first then private and then protected and then the same thing with functions.
  • After declaration of a function you need to put the exponents on a new line.
  • After declaration of a class you need to put the exponents on a new line.
  • Each line can not exceed 138 characters.
  • No extra whitespaces are not allowed.

Credits

Best Regards, Celestial Body People