From e4cfb808bf14f88efab48668843e7d205fdabaf9 Mon Sep 17 00:00:00 2001 From: sp2xdev <127630192+sp2xdev@users.noreply.github.com> Date: Sun, 4 May 2025 00:38:10 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f26733e..a9b5a11 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,5 +86,9 @@ if (conditional) } ``` -* Please give [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) a read. Though, we don't use GSL. +* Please give [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) a read. A few things to point out in spice codebase: + * We don't use GSL. + * Don't throw exceptions. + * Stick to smart pointers. For interfacing with C Win32 API and raw buffers, use `unique_plain_ptr`. + * Writing in C is also completely acceptable. * Other than that, there are no strict rules for code formatting, but please attempt to emulate the style around the code you are modifying.