From 64abc9cc76ff82673588cd9c48a61af7008c9804 Mon Sep 17 00:00:00 2001 From: Mike Solar Date: Mon, 13 Jul 2026 15:27:57 +0800 Subject: [PATCH] docs: update CONTRIBUTING.md to Linux Kernel Coding Style - Reference Linux Kernel Coding Style instead of Google C++ Style Guide. - Require tabs for indentation. - Keep Javadoc-style documentation comments. - Preserve the original naming rules section. - Update project name to Oak Video Editor. --- CONTRIBUTING.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76d28c4b2..6fedd8155 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to Olive +# Contributing to Oak -Thank you for your interest in contributing to Olive! +Thank you for your interest in contributing to Oak Video Editor! ## Writing code @@ -16,9 +16,11 @@ In order to keep the code as readable and maintainable as possible, code submitted should abide by the following standards: * The code style generally follows the - [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) - including, but not limited to: - * Indentation is 4 spaces wide, spaces only (no tabs) + [Linux Kernel Coding Style](https://www.kernel.org/doc/html/latest/process/coding-style.html) + with the following project-specific exceptions and notes: + * Indentation uses **tabs**, not spaces. + * Documentation comments should use **Javadoc-style** (`/** ... */`) where appropriate. +* The naming rules below are retained from the original Olive codebase: * `lowercase_underscored_variable_names` * `lowercase_underscored_functions()` or `SentenceCaseFunctions()` * `class SentenceCaseClassesAndStructs {}` @@ -27,4 +29,3 @@ submitted should abide by the following standards: * `class_member_variables_` end with a `_` * 100 column limit (where it doesn't impair readability) * Unix line endings (only LF no CRLF) -* Javadoc documentation where appropriate