From 78fc5c408b0736c7142d4b4bf2b19812114b36e8 Mon Sep 17 00:00:00 2001 From: Maxim Poliakovski Date: Thu, 5 Mar 2020 11:53:28 +0100 Subject: [PATCH] CONTRIBUTING: Use code blocks for code examples. --- CONTRIBUTING.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 519032b..80a4ff8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,15 +12,14 @@ Code * All code must be compatible with at least C++11. * Minimize the amount of redundant code. * Avoid using absolute paths for the headers. -* Code should maintain vertical alignment. An example of this is provided below: +* Code should maintain vertical alignment for better readability, for example: -> one_hundred = 100; -> one_thousand = 1000; +```C +one_hundred = 100; +one_thousand = 1000; +two_thousand = 2000; +``` -** The following should be avoided: - -> one_hundred = 100; -> one_thousand = 1000; * CamelCase for class names, lowercase for variables, UPPERCASE for enumerations * Avoid redundancy in namespaces (i.e. use ViaCuda::read() instead of ViaCuda::cuda_read())