Contributing - ankidroid/Anki-Android GitHub Wiki

Introduction

AnkiDroid is free (open source) software, and is run entirely by volunteers. This page contains information on how you can contribute back to the AnkiDroid project.

Here are some links to other pages related to contributing to AnkiDroid:

Donate to AnkiDroid

You can support AnkiDroid's development by donating. Any amount is deeply appreciated.

Answer questions on the forum

Providing support for users can place a significant burden on the developers, so one of the easiest ways that you can contribute back to AnkiDroid is by regularly answering questions that you know the answer to on the forum.

Rate AnkiDroid

Hearing positive feedback is a motivation booster for all involved, and a better rating means more people using AnkiDroid and sharing decks.

Translate AnkiDroid

Take screenshots

For each language we need:

  • A few screenshots on a normal phone (review with image, review with sound, card edition, deck list)
  • At least one screenshot on a ~7inch screen
  • At least one screenshot on a ~10inch screen

Here are all screenshots we have, so you can see which ones are missing: https://github.com/ankidroid/Anki-Android/tree/main/docs/marketing/screenshots

Send the images to the forum so that we can use them to improve the Play Store page, the Wiki, etc.

You can download various shared decks to show nice content. To take a screenshot, press the "Power" and "Volume down" buttons simultaneously. You can use the emulator if you don't have any 7inch or 10inch device.

To take screenshots for several languages, you can switch the AnkiDroid UI language in Preferences as explained above.

Other Non-developer tasks

  • Send us your ManualTesting results about the alphas/betas.
  • Blog about AnkiDroid and spread the word :-)
  • Follow us on Twitter and Facebook.
  • Here is a list of tasks that can be done by people who can't code.

Crash reporting system

It's sometimes possible for core and non-core developers to help with troubleshooting an error by looking at crash reports. You can find Crash Reports details here

Markets

Market Maintainer AnkiDroid Version Status Downloads
Google Play Nicolas Raoul and Tim 2.9.x Published 3,880,000
Amazon AppStore Tim 2.4 Published 10,014
Chrome Web Store @mikehardy 2.8.4 Published 16,130 on 20180911
AppsLib Mike Morrison 2.3.2 Published 1,157 (all versions)
Aptoide Nicolas Raoul 2.4alpha7 Published 0
FastApp Mike Morrison Referrer to Google's market 0.6 info published; 0.7 info submitted; FastApp appears to be down as of Nov. 2014 Unknown
GetJar Mike Morrison 0.7 0.7 published; 2.3.2 "Corrupt file! Android manifest not found." Help request has been sent. 3,684 (all versions)
Pdassi .com .de Mike Morrison 0.7 0.7 published; 2.3.2 "413 Request Entity Too Large". Help request has been sent. (note: non-English description text is copyright Pdassi) 2,150 (all versions)
SlideME Mike Morrison 2.3.2 Published 2,536 (all versions)
SmartAppFinder Mike Morrison 0.7 Published, but now the app link and login link are harder to find. Help request has been sent. Unknown
Soc.io Mall Mike Morrison 0.7 0.7 published; 2.3.2 to be reviewed 86 (all versions)
LenovoMM Appstore Nicolas Raoul 0.7beta10lenovo Published 2
Docomo Market Nicolas Raoul Facade to Google's market Published Can't be known
Ndoo (aka nduao, Nๅคšๅธ‚ๅœบ) Nicolas Raoul 1.1beta21 Published 13,131
telefon.de Nicolas Raoul Facade to Google's market Published Can't be known
F-Droid Anyone 2.9.6 Published (Auto-updating from GitHub releases) Can't be known
Direct APK download Nicolas Raoul and Tim all versions Published Thousands

Administration

Read Release Procedure for some insight on how AnkiDroid is released.

Localization Administration describes how Crowdin is managed under the hood.

Other open source Android flashcards apps

We are on very friendly terms with other app creators, and some have already re-used AnkiDroid's code. Feel free to compare apps and transfer one's strong points to the other(s) when applicable:

Answering to reviews

For use on Google Play, other markets, outside forums, and potentially any place where users talk about AnkiDroid.

Don't hesitate to talk in the name of the AnkiDroid team if you feel part of it. Feel free to adapt, but please stay diplomatic and welcoming, even in face of harsh criticism or foul language.

Review Answer
That rocks! (No reply)
That sucks! (No reply)
I give up! (No reply)
It continuously crashes! Hello NAME, sorry for the inconvenience! You can try uninstalling and re-installing as this often fixes such bugs. If not, please report the problem at https://github.com/ankidroid/Anki-Android/issues/new , including as many details as possible (Android version, device, steps that lead to the problem) and we'll look into it. Thanks for using AnkiDroid!
How can I do X? (already in the manual) Hello NAME, thanks for your feedback! Please read the corresponding section of the manual at ankidroid.org/manual.html#ENTRY and see if that answers your question. Thanks for using AnkiDroid!
There is a problem with X (already in tracker) Hello NAME, thanks for your feedback! This problem is being investigated at TRACKERURL , please check whether it matches what you mean, and "star" that page to receive notifications. Thanks for using AnkiDroid!
There is a problem with X (not in tracker) Hello NAME, thanks for your feedback! Please report the problem at https://github.com/ankidroid/Anki-Android/issues/new , including as many details as possible (Android version, device, steps that lead to the problem). Thanks for using AnkiDroid!
You should add feature X (already in tracker) Hello NAME, thanks for your idea! This idea is debated at TRACKERURL , please check whether it matches what you mean, and "star" that page to receive notifications. Thanks for participating in AnkiDroid!
You should add feature X (not in tracker) Hello NAME, thanks for your idea! Please suggest it at https://github.com/ankidroid/Anki-Android/issues/new so that volunteers can see it and keep track of it. Thanks for participating in AnkiDroid!
I lost my decks! Hello NAME. Sorry about the inconvenience. Fortunately, AnkiDroid makes regular backups, so chances are you can recover your decks. Please have a look at http://ankidroid.org/docs/manual.html#backups and if you still have problems send a message to the mailing list at [email protected]. Thanks for your patience!
I lost my decks (Japanese) NAMEๆง˜ใ€ใ”้€ฃ็ตกใ„ใŸใ ใใ‚ใ‚ŠใŒใจใ†ใ”ใ–ใ„ใพใ™ใ€‚ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใ‹ใ‚‰ๅ…ƒใซๆˆปใ™ๅฏ่ƒฝๆ€งใŒใ”ใ–ใ„ใพใ™ใฎใงใ€ใชใ‚‹ในใๆ—ฉใใƒกใƒผใƒชใƒณใ‚ฐใƒชใ‚นใƒˆใธใ”้€ฃ็ตกใ—ใฆใ„ใŸใ ใ‘ใชใ„ใงใ—ใ‚‡ใ†ใ‹ใ€‚ใ‚ขใƒ‰ใƒฌใ‚นใฏ[email protected]ใงใ™ใ€‚ใ‚ˆใ‚ใ—ใใŠ้ก˜ใ„่‡ดใ—ใพใ™ใ€‚
You can't change any options AnkiDroid is designed to show you the cards just before you forget them, in order to minimize wasted study time. If the default settings are not working well for you, you can adjust the intervals under "deck options". If you simply want to study more than necessary, it's better to use the "custom study" feature. Please see the manual for more info.
Some characters don't show Hello, It is likely that your Android device does not support those specific characters in its default font. If that's the case you can use a custom font instead: https://ankidroid.org/docs/manual.html#customFonts

Contributors

Many thanks to all of the people and companies who contributed to AnkiDroid! :

  • A hundred people are working on the code, some sending just one patch, some becoming very involved.
  • Simplified Chinese translation by / ็ฎ€ไฝ“ไธญๆ–‡็‰ˆ ๅฎ‰ๆ™บ็ฝ‘ๆฑ‰ๅŒ– http://goapk.com
  • A thousand of translation contributors
  • Hundreds of people are participating in the forum
  • And thanks to the millions of AnkiDroid users!

We are very welcoming and open, please join us!

โš ๏ธ **GitHub.com Fallback** โš ๏ธ