Getting Started with Cboard Development

Interested in contributing to Cboard? Thanks! There are plenty of ways you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features. Follow this guide to get up and running.

A few things to know

In order to contribute as a developer, you will need to have a basic understanding of React and probably Redux, you will also need to be familiar with Material-UI. It is highly recommended that you read Cboard Contributing guide so that you know code guidelines as well as what is required when you want to submit a change.

Developer Chat

Our developer community is always helpful to new developers wanting to get their feet wet with Cboard programming. If you ever need help you can join the developer chat on Discord here: https://discord.gg/cboard

Starting Cboard Development

1. Get the code

Check out the source code for Cboard from Github: https://github.com/cboard-org/cboard

git clone --recursive https://github.com/cboard-org/cboard.git

Don't forget the --recursive argument to get all submodules.

2. Build the code

The next step is to get the program building so that you can start making your modifications.

3. Read the documentation

Cboard reference documentation can be found here: Cboard Architecture Reference

It's also recommended to examine some of the featured repositories to see how they interact with Cboard, specially the API repository, and the Mobile application repository, so you can begin to see how the different modules of code fit together.

4. Check out issues on the Ideas page and the Bug Tracker

Many user post ideas and suggestions for improvements to Cboard on the discussions page. You can find the page here: https://github.com/cboard-org/cboard/discussions/

OBS Studio currently tracks bugs on GitHub Issues.

Feel free to explore ideas, issues, suggestions, and bugs, and if you feel so inclined, try your hand at implementing one!

A quick note about licensing

OBS Studio is an open source program licensed under the GPLv2. That means that if you create a plugin for OBS Studio or a modified version of OBS Studio and distribute it in binary form, you must give users a way to access the source code of your binary. Otherwise, you will be in violation of the license. The easiest way to do this is to have a public Github repository of your fork or plugin, and include a text file in your download for the binary containing a link to the repo. The relevant part of the license is under section 3 of the GPLv2.

Thanks for being willing to help out, and good luck!