Skip to content

Coding Guidelines

Jump to bottom
Rakesh edited this page May 24, 2020 · 1 revision

These guidelines are written, not only to make the code base more consistent, but also to make it easier for the project collaborators to merge pull requests from the contributors.

Whitespaces

  • Use spaces, not tabs.
  • Use 4 spaces to indent.
  • Lines should not contain trailing spaces.

Symbols and Naming conventions

  • Use US English names for all variables, functions and classes.
  • Don't use underscore for private variables. Example: myVariable instead of _myVariable.

General stuff

  • Do not leave unused import statements.

When creating a pull request, make sure that...

  • ... you only changed the code you intended to change. If you have added whitespace characters or in any other way changed code that is not a part of your particular fix, the pull request will not get merged. So please check your pull request before submitting. If you see something unrelated that needs to be cleaned up, fix it in a separate pull request.
  • ... the code you just wrote has decent test coverage.

Clone this wiki locally