doc: add information about how to contribute
Inspired by the document at jitsi/jitsi.
This commit is contained in:
parent
4ad98ca505
commit
92f58cb3c1
|
@ -0,0 +1,33 @@
|
||||||
|
# How to contribute
|
||||||
|
We would love to have your help. Before you start working however, please read
|
||||||
|
and follow this short guide.
|
||||||
|
|
||||||
|
# Reporting Issues
|
||||||
|
Before you open an issue on GitHub, please discuss it on one of our
|
||||||
|
[mailing lists](https://jitsi.org/Development/MailingLists) and wait for
|
||||||
|
confirmation from one of the committers. Once you have that confirmation,
|
||||||
|
please proceed to reporting the issue on GitHub, while providing as much
|
||||||
|
information as possible. Mention the version of Jitsi Meet, Jicofo and JVB
|
||||||
|
you are using, and explain (as detailed as you can) how the problem can
|
||||||
|
be reproduced.
|
||||||
|
|
||||||
|
# Code contributions
|
||||||
|
Found a bug and know how to fix it? Great! Please read on.
|
||||||
|
|
||||||
|
## Contributor License Agreement
|
||||||
|
While the Jitsi projects are released under the
|
||||||
|
[Apache License 2.0](https://github.com/jitsi/jitsi-meet/blob/master/LICENSE), the copyright
|
||||||
|
holder and principal creator is [Atlassian](https://www.atlassian.com/). To
|
||||||
|
ensure that we can continue making these projects available under an Open Source license,
|
||||||
|
we need you to sign our Apache-based contributor
|
||||||
|
license agreement as either a [corporation](https://jitsi.org/ccla) or an
|
||||||
|
[individual](https://jitsi.org/icla). If you cannot accept the terms laid out
|
||||||
|
in the agreement, unfortunately, we cannot accept your contribution.
|
||||||
|
|
||||||
|
## Creating Pull Requests
|
||||||
|
- Make sure your code passes the linter rules beforehand. The linter is exeuted
|
||||||
|
automatically when committing code.
|
||||||
|
- Perform **one** logical change per pull request.
|
||||||
|
- Maintain a clean list of commits, squash them if necessary.
|
||||||
|
- Rebase your topic branch on top of the master branch before creating the pull
|
||||||
|
request.
|
|
@ -86,6 +86,11 @@ npm unlink lib-jitsi-meet
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
If you are looking to contribute to Jitsi Meet, first of all, thank you! Please
|
||||||
|
see our [guidelines for contributing](CONTRIBUTING.md).
|
||||||
|
|
||||||
## Embedding in external applications
|
## Embedding in external applications
|
||||||
|
|
||||||
Jitsi Meet provides a very flexible way of embedding it in external applications by using the [Jitsi Meet API](doc/api.md).
|
Jitsi Meet provides a very flexible way of embedding it in external applications by using the [Jitsi Meet API](doc/api.md).
|
||||||
|
|
Loading…
Reference in New Issue