There are dozens of ways to contribute in Weblate. Any help is welcomed, be it coding, graphics design, documentation or sponsorship.
Code and development¶
Weblate is developed on GitHub. You are welcome to fork the code and open pull requests. Patches in any other form are welcome too.
Check out Internals to see how Weblate looks from inside.
The code should follow PEP-8 coding guidelines. It is recommended to format new code using black code formatter (though existing code is yet formatted).
To check the code quality, you can use flake8, the recommended
plugins are listed in
You can execute all coding style checks with the script
Security by Design Principles¶
Any code for Weblate should be writted with Security by Design Principles in mind.
Testsuites exist for most of the current code, increase coverage by adding testcases for any new functionality, and verify that it works. Current test results can be found on Travis and coverage is reported on Codecov.
To run a testsuite locally, use:
DJANGO_SETTINGS_MODULE=weblate.settings_test ./manage.py test
You can also specify individual tests to run:
DJANGO_SETTINGS_MODULE=weblate.settings_test ./manage.py test weblate.gitexport
The tests can also be executed inside developer docker container, see Running Weblate locally in Docker.
See Testing in Django for more info on running and writing tests for Django.
Our issue tracker is hosted at GitHub:
Feel welcome to report any issues with, or suggest improvement of Weblate there. If what you have found is a security issue in Weblate, please consult the “Security issues” section below.
In order to give the community time to respond and upgrade your are strongly urged to report all security issues privately. HackerOne is used to handle security issues, and can be reported directly at HackerOne.
Alternatively, report to firstname.lastname@example.org, which ends up on HackerOne as well.
If you don’t want to use HackerOne, for whatever reason, you can send the report by e-mail to email@example.com. You can choose to encrypt it using this PGP key 3CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313 42B7 511D.
Starting with our codebase¶
If looking for some bugs to familiarize yourself with the Weblate codebase, look for ones labelled good first issue.
Quick overview of directory structure of Weblate main repository:
Running Weblate locally in Docker¶
If you have Docker and docker-compose installed, you can spin up the development environment simply by running:
It will create development Docker image and start it. Weblate is running on
<http://127.0.0.1:8080/> and you can login with
admin user and
password. The new installation is empty, so you might want to continue with
Adding translation projects and components.
docker-compose.yml for this are located in
The script also accepts some parameters, to execute tests run it with
parameter and then specify any
test parameters, for example:
./rundev.sh test --failfast weblate.trans
To stop the background containers run:
Running the script without args will recreate Docker container and restart it.
This is not suitable setup for production, it includes several hacks which are insecure, but make development easier.
Weblate is being translated using Weblate itself, feel free to take part in the effort of making Weblate available in as many human languages as possible.
Funding Weblate development¶
You can fund further Weblate development on the donate page. Funds collected there are used to fund gratis hosting for libre software projects, and further development of Weblate. Please check the the donate page for details, such as funding goals and rewards you can get by being a funder.
- Set final version by
- Make sure screenshots are up to date
make -C docs update-screenshots
- Create a release
- Enable building version docs on Read the Docs
- Update Docker image
- Close GitHub milestone
- Once the Docker image is tested, add a tag and push it
Developer’s Certificate of Origin¶
In contributing to the Weblate project, please certify to the following:
Weblate Developer’s Certificate of Origin. Version 1.0
By making a contribution to this project, I certify that:
The contribution was created in whole or in part by me and I have the right to submit it under the license of “GNU General Public License or any later version” (“GPLv3-or-later”); or
The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under GPLv3-or-later; or
The contribution was provided directly to me by some other person who certified (a) or (b) and I have not modified it.
I understand and agree that this project and the contribution are public and that a record of the contribution (including all metadata and personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with Weblate’s policies and the requirements of the GPLv2-or-later where they are relevant.
I am granting this work to this project under the terms of the GPLv3-or-later.
Please confirm your affirmation of the above by adding the following line to your patch:
Signed-off-by: Jane Developer <[email protected]>
using your real name (sorry, no pseudonyms or anonymous contributions).
If you are a developer authorized to contribute to Weblate on behalf of your employer, please use your corporate e-mail address in the “Signed-off-by” tag. If not, please use a personal e-mail address.