-
The main focus of this project is an intuitive and easy-to-use design.
-
Naming conventions are pretty straightforward: Classes, enums, etc. shall be
CamelCase
, anything else shall besnake_case
. Private and protected member variables shall have them_
prefix. A getter for a private or protected variable shall be the variable name without them_
(noget_
prefix). Setters shall have theset_
prefix. (just look at the code, its really straightforward) -
Choose clear and descritive names with as little abbreviation as possible.
In general, contribute anything that would be useful to you. Keep in mind that feature-rich != bloated.
In more detail:
-
Any optimization is welcome (as long as it doesn't break something important).
-
Useful overloads for existing features are welcome.
-
Documentation. Basically every public method needs to be documented at some point. Documentation can be very detailed, as long as it does not go into too much detail about the implementation.