Skip to content

Commit 31a4409

Browse files
committed
contrib : minor reword coding guidelines [no ci]
1 parent 10ef6c1 commit 31a4409

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@
2020
- Avoid adding third-party dependencies, extra files, extra headers, etc.
2121
- Always consider cross-compatibility with other operating systems and architectures
2222
- Avoid fancy-looking modern STL constructs, use basic `for` loops, avoid templates, keep it simple
23-
- 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
23+
- Vertical alignment makes things more readable and easier to batch edit
2424
- Clean-up any trailing whitespaces, use 4 spaces for indentation, brackets on the same line, `void * ptr`, `int & a`
2525
- Use sized integer types in the public API
26-
- Follow the existing code style, in case of doubt use `clang-format` to format the added code
2726
- Declare structs with `struct x {}` instead of `typedef struct x {} x`
2827
- In C++ code omit the `struct` keyword whenever it is not necessary
2928
> [!NOTE]
3029
> This guideline is yet to be applied to the `llama.cpp` codebase. New code should follow this guideline.
3130
- Tensors store data in row-major order. We refer to dimension 0 as columns, 1 as rows, 2 as matrices
3231
- 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.$
32+
- Try to follow the existing patterns in the code (indentation, spaces, etc.). In case of doubt use `clang-format` to format the added code
3333

3434
![matmul](media/matmul.png)
3535

0 commit comments

Comments
 (0)