Home Explore Help
Register Sign In
Apq
/
obs-studio
mirror of https://github.com/obsproject/obs-studio.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: d9f3482504
Branches Tags
obs-studio
/
CONTRIBUTING.rst

CONTRIBUTING.rst 2.0 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 
  1. Contributing
    2. 

  2. ============
    3. 

  3. 

  4. Quick Links for Contributing
    5. 

  5. ----------------------------
    6. 

  6. 

  7.  - Compiling and building OBS Studio:
    8. 

  8.    https://github.com/jp9000/obs-studio/wiki/Install-Instructions
    9. 

  9. 

  10.  - Our bug tracker (linked to forum accounts):
    11. 

  11.    https://obsproject.com/mantis/
    12. 

  12. 

  13.  - Development IRC channel: #obs-dev on QuakeNet
    14. 

  14.  
    15. 

  15.  - Development forum:
    16. 

  16.    https://obsproject.com/forum/list/general-development.21/
    17. 

  17. 

  18.  - Developer/API Documentation:
    19. 

  19.    https://obsproject.com/docs
    20. 

  20. 

  21.  - To contribute language translations, do not make pull requests.
    22. 

  22.    Instead, use crowdin.  Read here for more information:
    23. 

  23.    https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
    24. 

  24. 

  25. Coding Guidelines
    26. 

  26. -----------------
    27. 

  27. 

  28.  - OBS Studio uses kernel normal form (linux variant), for more
    29. 

  29.    information, please read here:
    30. 

  30.    https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst
    31. 

  31. 

  32.  - Avoid trailing spaces.  To view trailing spaces before making a
    33. 

  33.    commit, use "git diff" on your changes.  If colors are enabled for
    34. 

  34.    git in the command prompt, it will show you any whitespace issues
    35. 

  35.    marked with red.
    36. 

  36. 

  37.  - Tabs for indentation, spaces for alignment.  Tabs are treated as 8
    38. 

  38.    columns wide.
    39. 

  39. 

  40.  - 80 columns max
    41. 

  41. 

  42. Commit Guidlines
    43. 

  43. ----------------
    44. 

  44. 

  45.  - OBS Studio uses the 50/72 standard for commits.  50 characters max
    46. 

  46.    for the title (excluding module prefix), an empty line, and then a
    47. 

  47.    full description of the commit, wrapped to 72 columns max.  See this
    48. 

  48.    link for more information: http://chris.beams.io/posts/git-commit/
    49. 

  49. 

  50.  - Make sure commit titles are always in present tense, and are not
    51. 

  51.    followed by punctuation.
    52. 

  52. 

  53.  - Prefix commit titles with the module name, followed by a colon and a
    54. 

  54.    space (unless modifying a file in the base directory).  When
    55. 

  55.    modifying cmake modules, prefix with "cmake".  So for example, if you
    56. 

  56.    are modifying the obs-ffmpeg plugin::
    57. 

  57. 

  58.      obs-ffmpeg: Fix bug with audio output
    59. 

  59. 

  60.    Or for libobs::
    61. 

  61. 

  62.      libobs: Fix source not displaying
    63. 

  63. 

  64.  - If you still need examples, please view the commit history.
    65.