/
CONTRIBUTING.md
30 lines (20 loc) · 1.23 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# Contributing to OpenWebRTC
OpenWebRTC is still a relatively young project. Our ambition is to create an even more vibrant
and open community where our team from Ericsson Research is just one of many contributors.
We welcome all types of contributions, such as:
- Code
- Bug reports
- Documentation improvements
- Feature requests
- ...
If you would like to start working on a new feature, that you intend to include in the OpenWebRTC
project, we encourage you to reach out first so that we can avoid potential duplicate efforts:
[https:/github.com/EricssonResearch/openwebrtc/wiki/Community](https:/github.com/EricssonResearch/openwebrtc/wiki/Community).
## Code Style ##
We use the [WebKit coding style](http://www.webkit.org/coding/coding-style.html) and you check style using the check-webkit-style script with the following parameters:
`check-webkit-style -f -readability/naming/underscores,-readability/enum_casing,-readability/parameter_name,-build/header_guard $@`
## Roadmap ##
See [ROADMAP.md](https://github.com/EricssonResearch/openwebrtc/blob/master/ROADMAP.md).
## License ##
Every code patch accepted in the OpenWebRTC codebase is licensed under BSD-2.
You can see the complete license on `LICENSE` file on the root of repository.