diff options
| -rw-r--r-- | contributing.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md index a917166..cc22cd5 100644 --- a/contributing.md +++ b/contributing.md @@ -181,6 +181,18 @@ Print_color(Product_info::red); // Error: cannot convert Product_info to int. std::size_t i = 0; // use this instead of using a int double x = 0.0; ``` +- comment style guide, you can use TODO:, FIXME:, NOTE:, or HACK: as admonitions when needed. + +```cpp +// Compute the first 10,000 decimals of Pi. +// FIXME: Don't crash when computing the 1,337th decimal due to `increment` +// being negative. +``` +bad example +```cpp +// Draw loading screen. +draw_load_screen(); +``` ## CMakeLists specific |