Skip to content

Commit

Permalink
contrib : move coding guidelines to correct section [no ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
ggerganov committed Jan 11, 2025
1 parent 7637216 commit e015794
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.$

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit e015794

Please sign in to comment.