Skip to content

Latest commit

 

History

History
78 lines (69 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

78 lines (69 loc) · 2.48 KB

Contributing

German

Richtilinien zum Programmieren:

  • Ausschließlich objektorientierte Programmierung (Ausnahme: Utils)
  • Comments, Variablen, Methoden, System-outs, ... (Alles, was nicht an die user gerichtet ist) auf Englisch
  • Camel Case-Notation
  • Keine Fehler im Code nach Wechseln der Bukkit oder Spigot API (Reflections)
  • Variablen nutzen, keine Config-Zugriffe während des Spielens
  • Leerzeilen möglichst vermeiden -> Zeilen sinngemäß anordnen
  • Fields mit Annotations vor allen anderen mit Leerzeile
  • Getter-Setter unten und nacheinander - Methoden sinngemäß und nach reihenfolge sortieren
  • Sortierung nach Sichtbarkeit
    1. Private
    2. Protected
    3. Package
    4. Public
  • Sortierung der Methoden:
    1. Types
    2. Static Fields
    3. Static Intializers
    4. Fields
    5. Initializers
    6. Constructors
    7. Methods
    8. Static Methods

Richtlinien für GitHub:

  • Commits auf Englisch
  • Niemals auf den master pushen
  • Commit-Nachrichten kurz, sinngemäß und effizient beschreiben

Bei Missachtung der Richtlinien werden pushes verweigert und Rechte entzogen

English

Guidelines for programming:

  • Exclusively object-oriented programming (exception: Utilities)
  • Comments, variables, methods, system-outs, ... (Everything that is not addressed to the user) in English
  • camel case notation
  • No errors in code after changing the Bukkit or Spigot API (Reflections)
  • use variables, no config accesses during the game
  • Avoid blank lines if possible -> arrange lines accordingly
  • Fields with annotations before all others with blank line
  • Getter-setters below and one after the other - Sort the methods in the same order
  • Sorting by visibility
    1. Private
    2. Protected
    3. Package
    4. public
  • Sorting the methods:
    1. types
    2. Static fields
    3. Static Intializers
    4. Fields
    5. Initializers
    6. Constructors
    7. Methods
    8. Static Methods

Guidelines for GitHub:

  • Commits in English
  • Never push on the master
  • Describe commit messages briefly, meaningfully and efficiently

Disregard of the guidelines will result in denial of pushes and withdrawal of rights