Skip to content
Permalink
Branch: master
Find file Copy path
3 contributors

Users who have contributed to this file

@jp9000 @Dmitry-Me @RytoEX
67 lines (45 sloc) 2.1 KB

Contributing

Quick Links for Contributing

Coding Guidelines

  • OBS Studio uses kernel normal form (linux variant), for more information, please read here: https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst
  • Avoid trailing spaces. To view trailing spaces before making a commit, use "git diff" on your changes. If colors are enabled for git in the command prompt, it will show you any whitespace issues marked with red.
  • Tabs for indentation, spaces for alignment. Tabs are treated as 8 columns wide.
  • 80 columns max

Commit Guidelines

  • OBS Studio uses the 50/72 standard for commits. 50 characters max for the title (excluding module prefix), an empty line, and then a full description of the commit, wrapped to 72 columns max. See this link for more information: http://chris.beams.io/posts/git-commit/

  • Make sure commit titles are always in present tense, and are not followed by punctuation.

  • Prefix commit titles with the module name, followed by a colon and a space (unless modifying a file in the base directory). When modifying cmake modules, prefix with "cmake". So for example, if you are modifying the obs-ffmpeg plugin:

    obs-ffmpeg: Fix bug with audio output
    

    Or for libobs:

    libobs: Fix source not displaying
    
  • If you still need examples, please view the commit history.

You can’t perform that action at this time.