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
Pull requests
Coding standards
Conclusion

Resources

Reporting bugs

Prefered way to report a bug is to open an issue on GitHub. If not possible, you can also contact the development team directly with an e-mail.

Please look also at detailed instructions here here.

For general questions, ideas or remarks you are encountered to use the project's GitHub Discussions.

Feature requests

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

Pull requests

Pull request should be issued as a single branch originating from repository master branch, preferably rebased to current version. If multiple features are created, multiple pull requests containing every single feature should be issued.

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.

2.5 KiB Raw Blame History