Skip to content

Latest commit

 

History

History
24 lines (11 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

24 lines (11 loc) · 1.09 KB

Contributing

What should I know before contributing?

  • 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 be snake_case. Private and protected member variables shall have the m_ prefix. A getter for a private or protected variable shall be the variable name without the m_ (no get_ prefix). Setters shall have the set_ prefix. (just look at the code, its really straightforward)

  • Choose clear and descritive names with as little abbreviation as possible.

What can I contribute / where can I help?

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.