From de77372027053744604cba732dce318159289b76 Mon Sep 17 00:00:00 2001 From: heavydemon21 Date: Fri, 6 Sep 2024 09:41:13 +0200 Subject: style code example added and added more examples in contributing.md --- contributing.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 57a55b7..2d8a8cf 100644 --- a/contributing.md +++ b/contributing.md @@ -26,6 +26,39 @@ - [C++ core guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) - [Google c++ style](https://google.github.io/styleguide/cppguide.html) +```cpp +code-style-example/style.h +``` + +```cpp +code-style-example/style.cpp +``` + +```cpp +// good +class MyClass +{ +public: + void do_something(const int i); + void do_something(const std::string &str); +}; +``` + +```cpp +// instead of doing this +auto s = "Hello"; +auto x = "42"s; +auto x = 42; +auto x = 42.f; + +// Do this +std::string s = "Hello"; +std::string x = "42"s; +int x = 42; +float x = 42.f; +``` + + ## CMakeLists specific - Make sure list arguments (e.g. sources, libraries) given to commands (e.g. -- cgit v1.2.3