Skip to content

Development Guidelines

Matheus Vieira Portela edited this page Mar 18, 2014 · 24 revisions

This page contains guidelines that all project members should follow when producing new source code for the UnBall Robot Soccer Team. These rules aims to produce consistent code, which can be easily understood and maintained.

Coding style

The most important coding style is: be consistent. Writing code in a consistent style makes it easier to read, hence, it is strongly recommended to follow the coding style suggestions below.

Formating

  • Identation: Indent 4 spaces at a time and use spaces only.
  • Line Length: Each line should be 120 characters long.

Documentation

Unit testing

Version control

Git

Pull -> modify -> add -> commit -> log -> push

Most used commands

Issue tracking

Code review

Clone this wiki locally