Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1 KB

Not absolutely required, but try to follow these rules when writing code to Plasma 5 Genial:

General

  • Write in English

    Don't need to be perfect and follow all the dictionary rules, but write something that everyone can understand

  • No Ninja Coding

    Try to put a name in the variables/objects/anything that actually describe what its doing there. Not a, b, or something like this

  • Document your methods and types

    Add a bit of explanation about what your method/variable/type should do

    Syntax

  • Curly braces in the same line as the statement

    Example
    if() {
    

    not

    if()
    {
    
  • Spaces after and before each open curly braces

    Example
    if() {
    

    not

    if(){
    

These rules are not absolutely required, I won't refuse your code if you forgot a trailing space or something, but try to follow it =)