oak-editor/CONTRIBUTING.md

Contributing to Oak

Thank you for your interest in contributing to Oak Video Editor!

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 Linux Kernel Coding Style 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 {}
  • 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)