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.
This commit is contained in:
2026-07-13 15:27:57 +08:00
parent f0d41eae52
commit 64abc9cc76
+7 -6
View File
@@ -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