Development Coding standards

Michael Corcoran edited this page Oct 21, 2015 · 2 revisions
Clone this wiki locally

General Standards

  • Line endings should be just LF, i.e. Unix style.
  • Git commit messages should be in the Linux kernel style. Please try to write good git commit messages. The header line should explain the commit independently of the body because tools like gitk and Github summaries only show this line. A good commit message looks like this:
    Header line: explaining the commit in one line

    Body of commit message is a few lines of text, explaining things
    in more detail, possibly giving some background about the issue
    being fixed, etc etc.

    The body of the commit message can be several paragraphs, and
    please do proper word-wrap and keep columns shorter than about
    74 characters or so. That way "git log" will show things
    nicely even when it's indented.

    Reported-by: whoever-reported-it
    Signed-off-by: Your Name <youremail@yourhost.com>

Flight Code

The flight side code tries to stick as much as possible with the linux kernel style. There are some small exceptions:

  • Variables should be named using underscores rather than camel-case with the exception of UAVOs. UAVO code is auto-generated and uses camel-case to help distinguish it from regular symbols.

GCS Code

For the GCS code we use Qt style and Qt coding conventions