新开发者
欢迎!
您想要从事于维基媒体代码并需要从哪里开始的主意?
维基媒体技术社群总是欢迎我们计划的新贡献者。
成为全域社群的一员,帮助每个人更轻松地获取免费知识!
贡献维基媒体可分为四个步骤:
基础知识
如果您已经习惯了自由和开放源码的软件文化,那么可以跳过此部分。
Wikimedia在许多不同领域有数百个软件项目。 如果你想了解概况,请查看这些幻灯片。
每个软件项目的维护者都可以很自由地选择他们喜欢的基础结构。 一般来说,基本上所有的软件项目都有
- 一种任务追踪工具,用于报告、管理和讨论软件bug和改进请求。例如Wikimedia Phabricator、GitHub或Sourceforge。
- 一个源代码库,源代码可以复制到每个人的代码存储库。例如Wikimedia Git/Gerrit、GitHub或Sourceforge。
- 一个代码检查工具,用于讨论和改进建议的代码更改(patches)。例如Wikimedia Git/Gerrit、GitHub或Sourceforge。一旦你提出的patch很好,并被合并到代码库中,你的代码更改将对每个人都可用。(你可以在这里阅读更多关于代码审查的良好实践。)
- 讨论软件项目和/或接受帮助和支持的场所。这些地方可以是邮件列表,或IRC聊天频道,或wiki页面,或其他地方。具体的位置取决于每个项目。你也可以在他们的用户页面上通过“电邮联系该用户”联系特定的用户,但是要注意私下问的问题不会帮助到他人。
在任何时候,如果你遇到问题或需要帮助,请提问。 如果你想在合适的地方提出好的问题,我们建议你阅读“反馈、问题和支持”部分。
选择软件项目
这是推荐的开始方式。 选择下列项目之一,并按照项目的帮助文档配置您的开发环境,选择一个任务,解决该任务,并提交您的代码更改以供检查:
一个提供给Wikimedia项目的反破坏桌面应用程序
- 所需技能: 使用Qt的C++
- 取得联系: Mailing list / 在irc.freenode.net上的#huggle 连接讨论
- 获取源代码: GitHub
- 阅读用户和开发者文档
- 检查建议执行的任务: Phabricator
- 导师: Peter Bena
维基百科网页内容的离线阅读器
- 所需技能: Java (Android app), Swift (iOS app)
- 取得联系: Mailing list / 在irc.freenode.net上的#kiwix 连接讨论
- 获取源代码: GitHub
- 阅读通用文档和相应项目的README.md文件
- 检查建议执行的任务: Android, iOS, JS on GitHub
- 导师: Matthieu Gauthier, Emmanuel Engelhart, Stephane Coillet-Matillon
适用于安卓的维基共享资源应用程序
适用于安卓设备的应用程序,用于将您的图片上传到维基共享资源
- 所需技能: Java
- 取得联系: Google Groups
- 获取源代码: GitHub
- 阅读文档
- 检查建议执行的任务: GitHub
- 导师: Josephine Lim
ORES
为Wikimedia项目提供机器学习服务的web服务和API。 机器预测用于发现破坏行为、衡量条目质量和执行其他wiki工作。
- 所需技能:
- 翻译和语言资源:能说和写任何非英语语言
- 前端开发: HTML, JavaScript, CSS
- 后端开发: Python, Redis, Postgres
- Modeling: Python, Scikit-learn
- 扩展: PHP (mediawiki), MariaDB
- 取得联系: 电子邮件列表 / Chat in #wikimedia-ai 连接 on irc.freenode.net
- 获取源代码: wiki-ai/ores, wiki-ai/revscoring, wiki-ai/wikilabels
- 阅读文档
- 检查建议执行的任务: Phabricator
- 导师: Aaron Halfaker & Adam Wight
借书证平台
- 所需技能: Python, Django
- 取得联系: #wikipedia-library 连接 on irc.freenode.net / wikipedialibrary
wikimedia.org
- 获取源代码: GitHub
- 阅读[https://github.com/WikipediaLibrary/TWLight/blob/master/README.md
Pywikibot
A Python library and collection of scripts that automate work on MediaWiki sites.
- 所需技能: Python
- 取得联系: #pywikibot 连接 on irc.freenode.net / Mailing list
- 获取源代码: Use git to get the source code
- 阅读文档
- 检查建议执行的任务: Phabricator
- 导师: Dvorapa
Are you a maintainer and want your project to be included in the list of software projects above? Find out more and join!
外联项目和单一任务
Apart from the recommended software projects above, there are more ways to choose a project or task to work on:
外展计划
Good first tasks
However, you are more on your own here: We cannot guarantee that mentors are available or that your proposed patches will receive fast reviews.
寻找更多资源?
- How to become a MediaWiki hacker: For potential new developers who want to specifically work on MediaWiki core or MediaWiki extensions.
- Developer hub: Resources to more documentation and information for established Wikimedia developers.
- There are also several email lists for discussion of Wikimedia software.
- Wikimedia tutorials: An index of tutorials that feature various languages, APIs, and frameworks in the Wikimedia technology stack.
协助其他贡献
- 如何贡献列出了许多非技术领域的贡献方式。
Some general communication tips
- Do your research first: When you decide to work on a task, you are expected to do some basic research yourself first: Look at the code, try to get some understanding what it is supposed to do, read related documentation, try to find the probable place(s) where you need to make code changes. For a general overview, please read the Basics to know.
- In a Phabricator task, see the project tags in the side bar to find out which code repository a task is about.
- Ask and discuss in the best place:
- In Phabricator tasks, discuss only specific questions about the topic of that very Phabricator task. General technical questions (e.g. how to set up a development environment or problems with Gerrit) are off-topic in Phabricator tasks.
- For general technical questions, ask the broader Wikimedia community and use generic channels like IRC chat or mailing lists. (If you take part in an outreach program, then you can also use Zulip's technical-support stream.)
- If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.
- Ask good questions: "Can you give me more info?", "Please guide me", "Please tell me how to start" are not good comments 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 fix the bug, maybe that bug is not (yet) for you – consider finding an easier one first.
- Provide context: When asking, explain what you want to achieve, and what you have tried and found out already, so others can help at the right level. Be specific – for example, copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words. This avoids misunderstandings.
- Ask in public: Do not send private messages if your conversation topic is not secret. Private messages do not help others.
- Be patient when seeking input and comments, especially during weekends and holidays.
- On IRC, don't ask to ask, just ask: most questions can be answered by other community members too if you ask on an IRC channel. If nobody answers, please try again at a different time; don't just give up.
- Do not ask people immediately for code review in a separate message. People receive Gerrit and Phabricator notifications.
- Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, please avoid unneeded quoting of a complete previous comment. Provide sufficient context and keep threads readable.
- Follow the code of conduct for Wikimedia technical spaces.
- When you plan to work on a Phabricator task:
- No need to ask for permission: Usually there is no reason to ask if you can work on something or if somebody could assign a task to you. There is no authority who assigns tasks or who needs to be asked first.
- You do not need to announce your plans before you start working on a task but it would be welcome. At the latest when you are close to proposing a patch for a task, it is good to announce that you are working on it, so that others don't duplicate work: If nobody else is already assigned, set yourself as task assignee by using the Add Action… → Assign/Claim dropdown.
- Tasks with existing patches:
- If a task already has a recent patch in Gerrit, choose a different task to work on instead – avoid duplicating work.
- If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could also improve that existing patch, based on the feedback in Gerrit and in the task.
- When your plans or interests change: If you don't work on a task anymore, please remove yourself as the assignee of the task, so others know that they can work on the task and don't expect you to still work on it.
By communicating clearly and early you get attention, feedback and help from community members.