UltraGrid/CONTRIBUTING.md

How to contribute to UltraGrid

First, thanks to contribute to UltraGrid by using UltraGrid, reporting bugs, adding code or ideas. Further section contains basic informations how to contribute. Feel free to inform us if you need to contribute in a different way or extend this document.

Table of contents

• Resources
• Reporting bugs
• Feature requests
• Coding standards
  • Indenting and whitespaces
  • Control structures
  • Spaces
  • Line length and wrapping
  • Naming conventions
• Conclusion

Resources

• Adding modules HOWTO
• Doxygen
• GitHub devel page
• Trello board tracking the development

Reporting bugs

You can either fill an issue at GitHub or contact our development team directly with the e-mail or use a chat. If you suspect that the issue may not be always replicable, you can use a script ultragrid-bugreport-collect.sh to collect data about a computer and attach its result. See also here.

Especially for various questions about UltraGrid usage you may also use our Matrix chat .

Feature requests

Feature requests can be submitted with the same channels as bugs.

Coding standards

TODO: incomplete

Indenting and whitespaces

• Default indent is 8 spaces width and consists solely of spaces, no tabs.
• Lines should be LF-terminated and there should not contain any whitespaces at the end.

Control structures

Control structures like if, while, switch etc. should have opening block bracket at the same line as the statement itself:

if (foo) {
        do_something();
} else {
        do_something_else();
}

Functions and methods, on the other hand, should have opening curly braces at the following line.

Spaces

Line length and wrapping

Naming conventions

Conclusion

Aside of what is enumerated above, we will be glad if you share with us your setup, photos or just ideas.