# The rules to follow when working on this project

## Basic rules


- Start each file by a file header!
- After **each update** of a file, please update the file changelog (in the header)!
- Indentation     : 4 (insert spaces)
- Max line length : 80 characters

---

## Naming conventions:

Files names   : `file_name`

Folders names : `folder_name`

Nodes names   : `NodesName`

Variables     : `variable_name`

Parameters    : `p_parameter_name`

Classes       : `Name_Name`

Objects       : `name_name`

Functions     : `name_name`

Signals       : `action` *example: `shot_fired` use past*

Signals Handlers : `on_<NodeName>_action` *example:* `on_AllyShip_fired`

Enum : `Name` *example:* `Jobs`

## File's header

```
#------------------------------------------------------------------------------
#-- Copyright (c) 2021 Lyaaaaaaaaaaaaaaa
#--
#-- Author : xxx
#--
#-- Portability Issues (feel free to remove this part if there is none):
#--  - xxx
#-- Implementation Notes:
#--  - 
#-- Anticipated changes:
#--  - 
#-- Changelog:
#--  - dd/mm/YYYY author
#--    - [List changes here]
#------------------------------------------------------------------------------
```
