diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c336fd969..579cbdb7c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,16 +74,19 @@ - Declare structs with `struct x {}` instead of `typedef struct x {} x` - In C++ code omit the `struct` keyword whenever it is not necessary - - Use the `_t` suffix when the types are supposed to be opaque to the user - it's not relevant to them if it is a struct or anything else + > [!NOTE] + > This guideline is yet to be applied to the `llama.cpp` codebase. New code should follow this guideline. - ```cpp - typedef struct llama_context * llama_context_t; +- Use the `_t` suffix when a type is supposed to be opaque to the user - it's not relevant to them if it is a struct or anything else - enum llama_pooling_type llama_pooling_type(const llama_context_t ctx); - ``` + ```cpp + typedef struct llama_context * llama_context_t; - > [!NOTE] - > This guideline is yet to be applied to the `llama.cpp` codebase. New code should follow this guideline. + enum llama_pooling_type llama_pooling_type(const llama_context_t ctx); + ``` + + > [!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