Skip to main content

How to write a report

Language

All reports should be written in english.

Naming convention

format: year-month-day_TYPE_number_subject
example: 2025‐10‐22_TECH_001_libyara

The accepted types are the following:

  • TECH - report on a technical part of the project like a technology shift
  • PERF - performance report, a performance report should be commented and contain a conclusion raw data should stay in it's assigned section
  • ORGA - report on a aspect of our organisation, can be a retrospective or a new the implementation of a new process
  • BUGR - bug report, report on a specific bug and its implication
  • VEIL - report on an technology watch

Header

first line​

format: > repport n°xxx | year-month-day
example: > repport n°001 | 2025-10-22

title​

format: should reflect the content of the post
example: Shift from the "yara" library to the "yara-x" library

Body

Most of the reports will follow the same structure except for PERF and some VEIL.

The 3 parts​

  • the context
  • what happened
  • the reaction

Footer

full names of the ones who made the report​

format: Written by: name | name | name
example: Written by: Raphaël Mabille | Alexis Boitel

Special case

Performance report​

To be defined

Technical watch report​

To be defined