Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.17 KB

CONTRIBUTING.rst

File metadata and controls

69 lines (46 loc) · 2.17 KB

Contributing

Quick Links for Contributing

Coding Guidelines

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 each commit's titles with the module name, followed by a colon and a space (unless modifying a file in the base directory). After that, the first word should be capitalized.

    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
    

    Note: When modifying cmake modules, just prefix with "cmake".

  • If you still need examples, please view the commit history.