aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
blob: d2e21fe097ba73fc3268a10a927839113e6f9b82 (plain)
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# 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 a 
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 you are using, your 
operating system and explain how the problem can be reproduced.

Please note that issues that are reported against a version older than the 
current stable release will be closed without further investigation. If you 
discover however that the issue also exists in an older version, this is 
useful information. Even more useful is to know if it worked in a specific 
version and stopped working in a subsequent version. This will help 
developers pinpoint the issue. Also useful is to test the nightly build.

# Translation
Please go to our [translation website](http://translate.jitsi.org), which is a
[Pootle](http://pootle.translatehouse.org/) instance that allows for easy
online translation. Many languages are already there and waiting for completion.

If your preferred language is not yet created, please drop us an
[e-mail](mailto:dev@jitsi.org). Be aware though that completing a new language
will be quite some effort, so be sure you actually want to take on that
work and translate more than a few words.

Please do not create any pull requests for the resources_XX.properties files,
as they will be overwritten with what comes from
[Pootle](http://translate.jitsi.org). The only exception is if you find
mistakes in the language file for
[English](https://github.com/jitsi/jitsi/blob/master/resources/languages/resources.properties).

For more information, e.g. how to translate offline visit the
[How To Translate Jitsi](https://jitsi.org/Documentation/HowToTranslateSIPCommunicator)
on our website.

# Code contributions
Found a bug and know how to fix it? Great! Please read on.

## Contributor License Agreement
While Jitsi is released under the
[Apache License](https://github.com/jitsi/jitsi/blob/master/LICENSE), the copyright
holder and principal creator is [Atlassian](https://www.atlassian.com/). To
ensure that we can continue making Jitsi 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.

## Coding Rules
- Please read and follow the [code conventions](https://jitsi.org/Documentation/CodeConvention),
  especially the limit on 80 characters per line.
- Do not reformat existing code.
- Command-Line [build instructions](https://jitsi.org/Documentation/RetrievingAndBuildingTheSources)
- How to set up [Eclipse](https://jitsi.org/Documentation/ConfigureEclipseNew)
- Read the [tutorials](https://jitsi.org/Documentation/DeveloperDocumentation) (some of this information might be a bit dated, but it is still a very useful resource)

## Creating Pull Requests
- 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.