Files
oak-editor/CONTRIBUTING.md
T
Mike-Solar f0d41eae52 build: rebrand output artifacts to Oak and fix macOS QML deployment
- Rename macOS bundle output from Olive.app to Oak.app.
- Rename editor binary to oak-editor and render worker to oak-render-worker.
- Rename crash handler output to oak-crashhandler.
- Update worker lookup, NSIS installer, Linux desktop/AppRun, crashhandler
  symbol paths, and documentation for the new binary names.
- Update CD workflow paths and add -qmldir flags to macdeployqt so QtQuick
  / QML plugins required by KDDockWidgets are bundled, fixing the launch
  crash on macOS.
- Update user-facing GitHub URLs to OakVideoEditorCommunity/oak.
2026-07-13 15:26:15 +08:00

1.3 KiB

Contributing to Olive

Thank you for your interest in contributing to Olive!

Writing code

Code contributions are welcome. Note that the code base is rapidly changing in the current stage of development however. There is some documentation in the form of code comments, including Javadoc in header files. Feel free to reach out via an issue or pull request if you have questions about the architecture or implementation details.

Code Standards

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 including, but not limited to:
    • Indentation is 4 spaces wide, spaces only (no tabs)
    • lowercase_underscored_variable_names
    • lowercase_underscored_functions() or SentenceCaseFunctions()
    • class SentenceCaseClassesAndStructs {}
    • kSentenceCaseConstants prepended with a lowercase k
    • UPPERCASE_UNDERSCORED_MACROS for variables or same style as functions for macro functions
    • 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