There are dozens of ways to contribute to Weblate. We welcome any help, be it coding help, graphics design, documentation or sponsorship.
Code and development¶
Weblate is being developed on GitHub <https://github.com/WeblateOrg/weblate>. You are welcome to fork the code and open pull requests. Patches in any other form are welcome as well.
Check out Internals to see how Weblate looks from inside.
The code should follow PEP-8 coding guidelines.
It is good idea to check your contributions using pep8,
pylint and pyflages. You can execute all checks
Developer’s Certificate of Origin¶
If you would like to make a contribution 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.
And please confirm your certification to 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 who is authorized to contribute to Weblate on behalf of your employer, then please use your corporate email address in the Signed-off-by tag. If not, then please use a personal email address.
We do write testsuite for our code, so please add testcases for any new functionality and verify that it works. You can see current test results on Travis <https://travis-ci.org/WeblateOrg/weblate> and coverage on Codecov <https://codecov.io/github/WeblateOrg/weblate>.
To run testsuite locally use:
./manage.py test --settings weblate.settings_test
You can also specify individual tests to run:
./manage.py test --settings weblate.settings_test weblate.gitexport
See Testing in Django for more information on running and writing tests for Django.
Our issue tracker is hosted at GitHub: <https://github.com/WeblateOrg/weblate/issues>
Feel welcome to report any issues or suggestions to improve Weblate there. In case you have found a security issue in Weblate, please consult the “Security issues” section below.
In order to give the community time to respond and upgrade we strongly urge you report all security issues privately. We’re currently using HackerOne to handle security issues, so you are welcome to report issues directly at <https://hackerone.com/weblate>.
Alternatively you can report them 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 email to email@example.com. You can choose to encrypt it using his PGP key 3CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313 42B7 511D.
Starting with our codebase¶
If you are looking for some bugs which should be good for starting with our codebase, you can find them labelled with good first issue tag:
If you have Docker and docker-compose installed you can spin up the development environment simply by running:
Earning money by coding¶
We’re using Bountysource to fund our development, you can participate on this as well by implementing issues with bounties:
Weblate is being translated using Weblate on <https://hosted.weblate.org/>, feel free to join us in effort to make Weblate available in as many world languages as possible.
Funding Weblate development¶
You can fund further Weblate development on Bountysource. Funds collected there are used to fund free hosting for free software projects and further development of Weblate. Please check the Bountysource page for details such as funding goals and rewards you can get for funding.
- Make sure screenshots are up to date
make -C docs update-screenshots
- Create a release
- Push tags to GitHub
- Update Docker image
- Close GitHub milestone
- Enable building version docs on Read rhe Docs
- Once Docker image is tested, add tag and push it