Google Code-in

Huggle is a fast diff browser application intended for dealing with vandalism on Wikimedia projects, written in C++. More information: https://en.wikipedia.org/wiki/Wikipedia:Huggle.

Source code is available at https://github.com/huggle/huggle3-qt-lx and can be compiled on Linux, Windows and MacOS.

In order to fulfill the task you should browse the code (https://github.com/huggle/huggle3-qt-lx), and / or documentation (https://github.com/huggle/huggle3-qt-lx/wiki + https://tools.wmflabs.org/huggle/docs) and try to identify some "weak" parts of it that are currently hard to understand for newbies and that should be better documented or refactored so that they are more clear. You can also try to follow instructions in order to compile Huggle on your platform and report back in case you had any issues, so that instructions can be modified to be more clear.

When you point these out, me or some other developers will help document them properly, or change them so that they are easier to understand.

In order to get credited for this task, you need to identify at least 1 part of the code or documentation that should be improved or documented so that it's easier to understand. You also need to point exactly what is not clear to you about the code / documentation text.

If you want to avoid troubles setting up C++ IDE, you can download preinstalled VM with everything ready for development: https://github.com/huggle/huggle3-qt-lx/wiki/Portable-development-environment