Code conventions

All languages

• Don't use more complicated constructs like ternary operators
• Keep functions short and simple.
• Define explicitly methods visibility, as several languages have different default values (e.g. private for C# class members, public for PHP methods)

C

If you use ClangFormat, a .clang-format file is available.

PHP

The following conventions are used:

• K&R, 1TBS variant, including for functions
• 4 spaces as indent
• The keywords true, false and null must be in lower case.
• Arrays use short syntax
• Array elements ends with a comma

If you use PhpStorm or another JetBrains IDE, you can import JetBrains/php-codestyle.xml from the codestyle repository as a code style (Settings or Default Settings > Editor > Code Style > PHP > click on the wheel icon > Import Scheme > Intellij IDEA codestyle XML).

If you want to lint a project with phpcs, you can require the Composer package nasqueron/codestyle and use the following phpcs.xml standard file:

<?xml version="1.0"?>
<ruleset>
    <rule ref="vendor/nasqueron/codestyle/CodeSniffer" />
    <file>.</file>
    <exclude-pattern>\.git/</exclude-pattern>
    <exclude-pattern>vendor/</exclude-pattern>
</ruleset>

Python

We follow PEP-8.

Rust

We follow Rust default style, described at https://aturon.github.io/. It's mainly a K&R, 1TBS variant.

Use trailing comma for elements in every struct/impl/etc.

Salt

Whitespaces:

• Indent with two spaces

Files provisioned:

• When you ask to download a file remotely, you need a source hash, pick SHA256 as algo
• Each file provisioned from the Salt repository must contains an header explaining the fact, with the full path in the rOPS repo

BSD and Linux distros compatible states:

• populate the map.jinja file with OS logic (e.g. `dirs` for /etc vs /usr/local/etc)
• when you've a specific set of tasks to do for one OS/distro, it's acceptable to enclose it in a state by an if block

Shell scripts

UNIX agnosticism:

• Don't assume absolute path, use #!/usr/bin/env bash and not #!/bin/bash (it could be elsewhere on BSD or Solaris)
• Use `sh` as must as possible, try to avoid bash, document exceptions rationale in your commits

Whitespaces:

• One whitespace line between shebang and actual content
• Indent with tabulations

File names:

• We use hyphens (-) as separators, not underscores or camelcase.
• Filename should start by a verb if it performs an action
• Don't use .sh extensions (sometimes you'll see them on Phabricator pastes' titles, but it has been added there, so Phab knows shell syntax highlighting should be used)

Utilities

The https://github.com/nasqueron/codestyle repository contains resource to help to respect code convention, like a phpcs ruleset, a configuration ready for PhpStorm, IntelliJ and other JetBrains editors, or a clang-format configuration file.