ca8d0bc1cf
+ added .clang-format to .gitignore
The style respects mostly rtp/rtp.{c,h} coding style (original
UltraGrid).
Rather than specifying own style, deduce one from clang-format default
format (just keeping the indention 8 spaces). The style is quite
restrictive because indention of 8 spaces + line with 80 restricts
nesting quite a bit.
Anyways, the style is rather a recommendation and is not enforced in any
way - .clang-format is just added to .gitignore and the developer can
tweak it a bit (like extending ColumnLimit).
2.2 KiB
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
- Adding modules HOWTO
- Doxygen
- GitHub devel page
- Trello board tracking the development
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
Style
Recommended style is modified LLVM clang-format style:
BasedOnStyle: LLVM
IndentWidth: 8
BreakBeforeBraces: Linux
The style is deduced from original rtp/rtp.{c,h} formatting and it is similar to Linux Kernel style (see here) without using tabs.
Naming conventions
Conclusion
Aside of what is enumerated above, we will be glad if you share with us your setup, photos or just ideas.