Skip to content

Latest commit

 

History

History
23 lines (22 loc) · 1018 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (22 loc) · 1018 Bytes

Contributing Guide

All contributions are welcome but please keep these things in mind before contributing.

Code style

  • All functions should be named in snake_case.
  • All classes and structs should named in PascalCase.
  • Enums should be named in all caps.
  • Similar types should be together like globals, structs and classes, separated by 3 empty lines.
  • Tab should be used for indentation.
  • Separate different preprocessor directives by two empty lines.
  • Similar includes should be kept together.
  • Standard library headers should be a the top, followed by global headers and finally locals one.
  • There should one line gap between these.
  • Using namespace statements should come next separated by a gap of two lines from the includes.
  • Below this the main code should be there after a gap of 3 lines.
  • Maximum line length should be 79.
  • Wrap only the words after the limit in a comment if there is no punctuations.
  • For documentation use comments like this:-
     /**
      * Comment like this
      */