Google Code-in/2016

Google Code-in is a contest to introduce pre-university students (ages 13-17) to the many kinds of contributions that make free and open source software (FOSS) development possible. Students must complete tasks, one at a time. It is sponsored and run by Google. The Wikimedia Foundation has participated since 2013.

The Google Code-in 2016 contest runs from November 28, 2016 to January 16, 2017 (see the full timeline).

Apply as a student Become a mentor now

Instructions for GCI students
Only after November 27th, when the Google Code-In contest opens for entries by student participants, come back to this wiki page to follow the instructions below. The instructions are common to all Wikimedia GCI tasks.

Register for the contest
Register on the Google Code-in site, and get a general overview of the contest provided by Google.

Choose tasks and read the related documentation

 * If you choose to work on a coding-related task, follow all the steps indicated in our “How to become a MediaWiki hacker” tutorial to setup the development environment, download our code from Git, and start submitting patches in Gerrit. Some helpful tips for the contest which are missing in the tutorial:
 * We recommend MediaWiki-Vagrant, for setting up the development environment for MediaWiki - a virtual machine that has the basic wiki software and various common extensions preconfigured.
 * Only if you have problems with Gerrit, providing your work in the corresponding task in Wikimedia Phabricator is an acceptable workaround.
 * Test your patches before submitting them for review in Gerrit! If you have submitted them without testing, clearly say so in an additional comment in Gerrit.
 * If you choose to work on any other task other than coding such as documentation, outreach, research, design, support, read our “How to Contribute” tutorial.

Ask for feedback, questions, and support

 * To communicate directly with your mentor, connect to the IRC channel they are frequently available at. See the list of mentors below. Your mentor will not always be around or awake - please just ask as other people might also be able to help.
 * If you have a specific question about a task, comment in the related Phabricator task. "What do I have to do to work on this?" is not a good question to start with. The more specific your questions are, the more likely somebody can answer them quickly. If you have no idea at all how to start working on a task - please consider finding an easier one first.
 * For general questions, refer to IRC channels, mailing lists, wiki discussion pages, or Gerrit discussion pages (if you have a problem with Gerrit).
 * Learn more at Communication.

Some general recommendations for communicating

 * Before reaching out to the members of the community with questions, do some basic research yourself first on the task and on the related issues you are facing: Look at the code, try to understand what it is supposed to do, and try to find the probable place(s) where you need to make changes in order to fix the bug.
 * Bug reports (also called "tasks") in Phabricator) have a "Tags" section in the upper right corner. There you can see the project that the problem is located in. This provides you a hint about the Git repository that the code is located in, and about the development team which you could contact if you want to discuss it in a "broader" way, as comments in bug reports should only refer to the specific problem described in the report. (Only if you work on the Kiwix project: Kiwix does not use Phabricator but instead uses Sourceforge).
 * Identifying yourself as a GCI student in our communication channels might help you get faster help from other members of our community.
 * Be patient when seeking input and comments. If you do not get an immediate response on an IRC channel, please ask on the phabricator task or wiki page related to the problem.
 * Avoid private emails or support requests in our social media channels.

List of Wikimedia mentors
Please be patient when seeking actions from mentors. Mentors are humans who eventually leave their computers to sleep, work, study. They might be in different timezones than you. It can take your mentor(s) up to 36 hours to review the work that you have submitted. You should be patient and should not ask for a review of your work after only a few hours of waiting. Google Code-In is about the quality of your contributions and learning how FOSS development works, not about the number of tasks that you have completed.

Mentors' corner
If you plan to be a mentor for GCI tasks, please refer to Google Code-in 2016/Mentors.

Common instructions for tasks
We want to use common texts in tasks wherever it makes sense to simplify the process of creating good task descriptions. Let's draft different levels of common texts: generic for all, specific to a category, specific to a type of task. When creating a task, use the levels that make sense. Let's link to on-wiki instructions and background as much as possible. This gives us freedom to improve content without having to edit multiple tasks.

For all tasks
The following sentence (set in WMF's profile) is appended to each task description on the GCI site:
 * Students must read Wikimedia's general instructions at https://www.mediawiki.org/wiki/Google_Code-in_2016#Instructions_for_GCI_students first.

Kiwix for Android


Kiwix is a Wikipedia offline reader which runs on Windows, GNU/Linux, OSX, iOS and Android. The Google Code-in tasks are related to the Android app, they require knowledge of the Java programming language and you also need a GNU/Linux distribution and basic knowledges about git.

To step in with a virtual machine, follow these instructions:
 * 1) Download the KiwixDev virtual machine (KiwixDev torrent)
 * 2) Import it on your prefered virtual machine (for example VirtualBox
 * 3) Launch the virtual machine

To step in without a virtual machine, follow these instructions:
 * 1) Install a GNU/Linux distribution, ideally Ubuntu (in a virtual machine like Virtualbox)
 * 2) Install development tools like git, autoconf, etc.
 * 3) Go to Sourceforge and create an account
 * 4) Click on the "Fork" button available here (you need to be logged)
 * 5) Clone your project using git clone on your local machine

Then:


 * ... follow the compilation instructions for Android

One time you think your code works and is good enough to be reviewed, do like following:
 * 1) Create a fork on Sourcefoge
 * 2) Commit and push your code from the command line using git
 * 3) Make merge request for your commit (using Sourceforge UI)