From b082e63fe81a3650599aef79e4d56d5afb2a731a Mon Sep 17 00:00:00 2001 From: max-001 Date: Tue, 5 Nov 2024 10:00:16 +0100 Subject: Improved example --- contributing.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 720985e..4c347bb 100644 --- a/contributing.md +++ b/contributing.md @@ -69,10 +69,15 @@ ```cpp // Good // This class handles the rendering process - class Renderer {}; + class Renderer { + // This method initializes the rendering context + void init_context(); + }; // Bad - class Renderer {}; // This class handles the rendering process + class Renderer { + void init_context(); // This method initializes the rendering context + }; ``` - Formatting nitty-gritty is handled by clang-format/clang-tidy (run `make format` in the root folder of this repository to format all sources files) -- cgit v1.2.3