weblate/CONTRIBUTING.md
2018-09-27 06:36:33 +02:00

46 lines
1.4 KiB
Markdown
Vendored

# Contributing to Weblate
As a libre copylefted project, Weblate welcomes contributions in many forms.
## Bug reporting
Please use the [issue tracker on GitHub][1]. Useful error reports contain a
backtrace if possible.
In production setup, admins receive it on the configured email address,
in debug mode, it is shown on screen and for management commands,
you can obtain the full backtrace using ``--traceback`` parameter.
Bugs might also be caused by third party libraries, so please include
their versions as well. You can collect them all using:
``./manage.py list_versions``.
[1]: https://github.com/WeblateOrg/weblate/issues
## Patch submission
Patches are welcome, either as [pull requests on GitHub][2] or using email on
[the mailing list][3]. Please include a Signed-off-by tag in the commit message
(you can do this by passing the `--signoff` parameter to Git). Note that by
submitting patches with the Signed-off-by tag, you are giving permission to
license the patch as GPLv3-or-later. See [the DCO file][4] for details.
[2]: https://github.com/WeblateOrg/weblate/pulls
[3]: https://lists.cihar.com/cgi-bin/mailman/listinfo/weblate
[4]: https://github.com/WeblateOrg/weblate/blob/master/DCO
## Running the development version locally
If you have Docker and docker-compose installed, you can spin up the development
environment by running:
```
./rundev.sh
```
## More info
To be found on the website:
https://weblate.org/contribute/