From e015794fe240cc286af43356863b10398112bc4a Mon Sep 17 00:00:00 2001 From: Georgi Gerganov Date: Sat, 11 Jan 2025 16:28:27 +0200 Subject: [PATCH] contrib : move coding guidelines to correct section [no ci] --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aaaf72e60dd598..341f5a6dfae9b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,8 @@ - Avoid fancy-looking modern STL constructs, use basic `for` loops, avoid templates, keep it simple - There are no strict rules for the code style, but try to follow the patterns in the code (indentation, spaces, etc.). Vertical alignment makes things more readable and easier to batch edit - Clean-up any trailing whitespaces, use 4 spaces for indentation, brackets on the same line, `void * ptr`, `int & a` +- Use sized integer types in the public API +- Follow the existing code style, in case of doubt use `clang-format` to format the added code - Tensors store data in row-major order. We refer to dimension 0 as columns, 1 as rows, 2 as matrices - Matrix multiplication is unconventional: [`C = ggml_mul_mat(ctx, A, B)`](https://github.com/ggerganov/llama.cpp/blob/880e352277fc017df4d5794f0c21c44e1eae2b84/ggml.h#L1058-L1064) means $C^T = A B^T \Leftrightarrow C = B A^T.$ @@ -30,7 +32,6 @@ # Naming guidelines - Use `snake_case` for function, variable and type names -- Use sized integer types in the public API - Naming usually optimizes for common prefix (see https://github.com/ggerganov/ggml/pull/302#discussion_r1243240963) ```cpp @@ -88,8 +89,6 @@ > [!NOTE] > This guideline is yet to be applied to the `llama.cpp` codebase. New code should follow this guideline. -- Follow the existing code style, in case of doubt use `clang-format` to format the added code - - (TODO: abbreviations usage) # Resources