Skip to content

Commit 9d438a4

Browse files
committed
contrib : expand [no ci]
1 parent b6f9640 commit 9d438a4

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

CONTRIBUTING.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,26 @@
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
2626
- Declare structs with `struct foo {}` instead of `typedef struct foo {} foo`
27-
- In C++ code omit the `struct` keyword whenever it is not necessary
27+
- In C++ code omit optional `struct` and `enum` keyword whenever they are not necessary
28+
```cpp
29+
// OK
30+
llama_context * ctx;
31+
const llama_rope_type rope_type;
32+
33+
// not OK
34+
struct llama_context * ctx;
35+
const enum llama_rope_type rope_type;
36+
```
2837
> [!NOTE]
2938
> This guideline is yet to be applied to the `llama.cpp` codebase. New code should follow this guideline.
3039
- Try to follow the existing patterns in the code (indentation, spaces, etc.). In case of doubt use `clang-format` to format the added code
40+
- For anything not covered in the current guidelines, refer to the [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines)
3141
- Tensors store data in row-major order. We refer to dimension 0 as columns, 1 as rows, 2 as matrices
3242
- 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.$
3343
3444
![matmul](media/matmul.png)
3545
36-
- Preprocessor directives
46+
# Preprocessor directives
3747
- (TODO: add guidelines with examples and apply them to the codebase)
3848
3949
```cpp
@@ -98,6 +108,12 @@
98108
99109
- (TODO: abbreviations usage)
100110
111+
# Documentation
112+
113+
- Documentation is a community effort
114+
- When you need to look into the source code to figure out implementation details to figure out how to use an API consider adding a short summary to the header file for future reference
115+
- When you notice incorrect or outdated documentation, please update it
116+
101117
# Resources
102118
103119
The Github issues, PRs and discussions contain a lot of information that can be useful to get familiar with the codebase. For convenience, some of the more important information is referenced from Github projects:

0 commit comments

Comments
 (0)