From edcc7bbd5c5ff519ed1e293903308995acc02117 Mon Sep 17 00:00:00 2001 From: Dora Date: Wed, 18 Jun 2025 01:02:28 +0200 Subject: [PATCH] some coding guidelines --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index f4c2548..e1c5f4a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ The Night Club's very own basic image hosting web frontend. +# Coing Guidelines + +In most of my projects I have less header(h/hpp) files than implementation files(c/cpp). This is very much intentional. I implement parts of a header file for ease of reading. You are expected to NOT make 1 header per 1 implementation file!!! + +When doing ``#include`` if the same include is used more than once in different implementation files that share a header file. Move the ``#include`` to the header file instead of having two of the same includes. + +Codebase must adhere to DRY and KISS (DRY KISS) principles! + # Building 1. To build the project you must install the header-only (a.k.a not-boost version) of ASIO.