Skip to content

Latest commit

 

History

History
118 lines (80 loc) · 4.35 KB

CONTRIBUTING.rst

File metadata and controls

118 lines (80 loc) · 4.35 KB
Raw

Contributing

Quick Links for Contributing

General Guidelines

  • The OBS Project uses English as a common language. Please ensure that any submissions have at least machine-translated English descriptions and titles.
  • Templates for Pull Requests and Issues must be properly filled out. Failure to do so may result in your PR or Issue being closed. The templates request the bare minimum amount of information required for us to process them.
  • Contributors to the OBS Project are expected to abide by the OBS Project Code of Conduct: https://github.com/obsproject/obs-studio/blob/master/COC.rst

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
  • Comments and names of variables/functions/etc. must be in English

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.

  • Commit titles and descriptions must be in English

AI/Machine Learning Policy

AI/machine learning systems such as those based on the GPT family (Copilot, ChatGPT, etc.) are prone to generating plausible-sounding, but wrong code that makes incorrect assumptions about OBS internals or APIs it interfaces with.

This means code generated by such systems will require human review and is likely to require human intervention. If the submitter is unable to undertake that work themselves due to a lack of understanding of the OBS codebase and/or programming, the submission has a high likelihood of being invalid. Such invalid submissions end up taking maintainers' time to review and respond away from legitimate submissions.

Additionally, such systems have been demonstrated to reproduce code contained in the training data, which may have been originally published under a license that would prohibit its inclusion in OBS.

Because of the above concerns, we have opted to take the following policy towards submissions with regard to the use of these AI tools:

  • Submissions created largely or entirely by AI systems are not allowed.
  • The use of GitHub Copilot and other assistive AI technologies is heavily discouraged.
  • Low-effort or incorrect submissions that are determined to have been generated by, or created with aid of such systems may lead to a ban from contributing to the repository or project as a whole.