mirror of
https://github.com/outbackdingo/UltraGrid.git
synced 2026-03-22 00:40:25 +00:00
64 lines
2.1 KiB
Markdown
64 lines
2.1 KiB
Markdown
# 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](#resources)
|
|
- [Reporting bugs](#reporting-bugs)
|
|
- [Feature requests](#feature-requests)
|
|
- [Coding standards](#coding-standards)
|
|
* [Indenting and whitespaces](#indenting-and-whitespaces)
|
|
* [Control structures](#control-structures)
|
|
* [Spaces](#spaces)
|
|
* [Line length and wrapping](#line-length-and-wrapping)
|
|
* [Naming conventions](#naming-conventions)
|
|
- [Conclusion](#conclusion)
|
|
|
|
## Resources
|
|
|
|
- [Adding modules HOWTO](ADDING-MODULES.md)
|
|
- [Doxygen](https://frakira.fi.muni.cz/~xpulec/ultragrid-doxygen/html/)
|
|
- [GitHub devel page](https://github.com/CESNET/UltraGrid/wiki/Developer-Documentation)
|
|
- [Trello board](https://trello.com/b/PjZW4sas/ultragrid-development) tracking the development
|
|
|
|
## Reporting bugs
|
|
You can either fill an issue at GitHub (preferred) or contact our development
|
|
team directly with the e-mail. 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](REPORTING-BUGS.md).
|
|
|
|
## 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.
|
|
|