新規開発者
このページではウィキメディア技術プロジェクトに貢献したい開発者が始める方法を説明します。
ようこそ!
ウィキメディアの技術コミュニティは、いつでも新しい貢献者を歓迎しています!
グローバルなコミュニティにぜひ参加して、フリーな知識へ誰でもより簡単にアクセスできるようにしましょう!
貢献を始める方法
以下の手順は貢献を始める方法の一般的な概要です:
- ウィキメディア・オープンソースソフトウェア・プロジェクトが作業する方法の基本を学ぶ。
- コミュニケーションガイドラインを読む。
- アカウントのセットアップ:開発者アカウントを作成する。やりたい貢献の種類によっては、Phabricatorでアカウントをセットアップし、GitとGerritをセットアップすることも必要になるかもしれません。
- ソフトウェアプロジェクトを選択する。
- タスクを選んで解決する(コードを書きテストする)。
- レビューのためにコード変更を提出する。 コードレビューを受けるためのガイドに従い、パッチを投稿する。
このガイドの残りの部分ではプロセスに関するさらなる詳細を提供します。
ウィキメディア・オープンソースソフトウェア・プロジェクトが作業する方法の基本
ウィキメディアは様々な分野にソフトウェア・プロジェクトがあります。
各ソフトウェア・プロジェクトのメンテナー(保守者)は、どのインフラストラクチャーを使うか自由に選びます。一般的に、たいていのソフトウェア・プロジェクトには以下があります:
- タスク追跡ツールでは、ソフトウェアのバグや拡張要求が報告・管理・議論されます。例えば、Wikimedia Phabricator、GitHub、ウィキメディアの GitLab といったものです。
- コード リポジトリでは、誰でもソースコードを「チェックアウト」できます。例えば、Wikimedia Git/Gerrit、GitHub、ウィキメディアの GitLab といったものです。
- コードレビューツールでは、提案されたコード変更(「パッチ」)が議論されて改善されています。例としては、ウィキメディアの Git/Gerrit、GitHub、GitLabなどがあります。あなたの提案したパッチが承認されコードリポジトリにマージされると、あなたのコード変更は誰でも入手できるようになります。
- ソフトウェアプロジェクトについて全般的な議論をする場所であり、ヘルプやサポートの場所です。これらの場所には、メーリングリストや IRCチャットチャンネル、ウィキ ページ、その他の場所があります。具体的な場所は、各プロジェクトによって異なります。
問題が発生したり、助けが必要な場合は、いつでも質問してください。適切な場所で適切な質問をするには、コミュニケーションのヒントに従ってください。
技術分野の概観
ウィキメディアの技術概要や開発者が貢献できる主要な領域の例は、ウィキメディアの技術エコシステム入門を参照してください。
MediaWikiでソフトウェアに貢献する
MediaWiki ウィキの利用者で、機能を追加したりバグを修正したりしたいですか? 必要な MediaWiki プロジェクトを見つけて貢献する方法は、MediaWikiハッカーになる方法 を参照してください。
ソフトウェアプロジェクトを選択する
以下のプロジェクトは、リソースやメンター制度を提供し、貢献してくれる新しい開発者を募集しています。 以下のいずれかのプロジェクトを選択し、プロジェクトのドキュメントに従って開発環境を設定し、作業するタスクを選択し、タスクを解決し、コードの変更をレビューに提出します。 これらのプロジェクトや、ウィキメディアに関連する他のプロジェクトに自由に貢献することができます。 たいていはPhabricator またはオンラインで検索することによって見つけることができます。
インターネットアクセスがない人々のためのオフラインリーダー
- 必要な技能: Java/Kotlin (Android), Swift (iOS), Qt (desktop), NodeJS (mediawiki offliner), C++, Python (WP1)
- 相談先: メーリング リスト / Slack
- ソース コードを取得: GitHub
- Read the general documentation and the README.md file of the corresponding project
- Check the recommended tasks to work on: Android, iOS, JS, mwoffliner on GitHub
- メンター: Matthieu Gauthier, Emmanuel Engelhart, Stephane Coillet-Matillon
Android用のコモンズアプリ
画像をウィキメディアコモンズにアップロードするAndroid端末用アプリ
- 必要な技能: Java
- 相談先: Google Groups
- ソース コードを取得: GitHub
- 説明文書をお読みください
- Check the recommended tasks to work on: GitHub
- メンター: Josephine Lim
Pywikibot
A Python library and collection of scripts that automate work on MediaWiki sites.
- 必要な技能: Python
- 相談先: #pywikibot 接続 on irc.libera.chat / Mailing list
- ソース コードを取得: Use git to get the source code
- 説明文書および API リファレンスをお読みください。
- Check the recommended tasks to work on: Phabricator
- メンター: xqt
Scribe
Scribe provides Wikidata based keyboards for second language learners. Features include translation, verb conjugation and noun-gender annotation. This project is very open to those who want to learn the needed languages and how to work with Wikidata!
- Skills required: Swift for Scribe-iOS; Kotlin for Scribe-Android; Python and/or Wikidata Query Service for our Scribe-Data language data extraction CLI
- Get in touch: GitHub or email
- Get the source code: GitHub
- Read the contribution guidelines: Scribe-iOS, Scribe-Android or Scribe-Data
- Check the recommended tasks: Scribe-iOS, Scribe-Android or Scribe-Data
- Mentor(s): Andrew McAllister
VideoCutTool
A tool to edit the videos on Wikimedia Commons.
- Skills required: React JS, Node JS.
- 相談先: #VideoCutTool in Zulip
- ソース コードを取得: See link in description in Phabricator
- 説明文書をお読みください。
- Check the recommended tasks to work on: Phabricator
- メンター: Gopa Vasanth
SignIt Firefox Extension
Lingua Libre SignIt web-browser extension translates selected written word via an elegant pop up so you learn sign language while reading online. You can add a signed video using Lingualibre.org by selecting a signed language, then video recording yourself while signing.
- Skills required : JS, web extension, OOjs
- Get in touch: contact Yug or on GitHub
- Get the source code: GitHub
- Read the documentation: m:Lingua Libre/SignIt
- Check the recommended tasks to work on: Good first issues on GitHub »
- Mentor(s): Yug
あなたはメンテナーで、プロジェクトを上記のソフトウェアプロジェクトのリストに入れたいと思っていますか?詳細をご覧になり、ご参加ください!
普及プログラムと単体のタスク
In addition to the recommended software projects above, there are more ways to choose a project or task to work on:
アウトリーチ プログラム
入門向けのタスク
しかしながら、これらのタスクに対して指導役が得られないかもしれず、皆さんが提案したパッチがすぐにレビューして貰えるとも限りません。
コミュニケーションのヒント
Follow these tips to communicate effectively and get help from community members.
Use Phabricator tasks effectively
When you plan to work on a Phabricator task:
- No need to ask for permission: You can work on unassigned tasks without asking someone to assign them to you. There is no authority who assigns tasks or who needs to be asked first.
- If a task already has a recent patch in Gerrit, choose a different task to work on instead.
- If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could improve that existing patch, based on the feedback in Gerrit and in the task.
- Do your research: When you consider working on a task, do research before you start coding. Look at the code, try to understand what it is supposed to do, read related documentation, and try to find the places where you need to make code changes.
- In a Phabricator task, use the project tags in the side bar to find the code repository for the task.
- If you have no idea at all how to fix the bug, consider finding an easier one first.
- You do not need to announce your plans before you start working on a task, but you should communicate that you are working on the task.
- When you start work, set yourself as task assignee by clicking Edit Task… in Phabricator, and set your Phabricator username in the Assigned To field. This communicates to others that you are working on it, so they don't duplicate work.
- When your plans or interests change: If you are no longer working on a task, remove yourself as the assignee of the task. This tells others that they can work on the task, and they won't expect you to still work on it.
- Follow Phabricator etiquette.
- In Phabricator tasks, discuss only specific questions about the topic of that task. Don't use Phabricator to ask general questions, like how to set up a development environment or how to fix problems with Gerrit.
Compose good questions
- Be specific and provide context: Instead of simply asking "Can you give me more info?", "Please guide me", or "Please tell me how to start", include the following information in your question:
- What are you trying to achieve?
- What have you already tried? Copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words.
- What have you found out already during your research? Include links to code, documentation, or other resources you already consulted.
- Use specific titles and subject lines in your communication. "Proposal draft" or "Need help" is not specific.
- Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, only quote sections of previous comments that are relevant to your response. If you quote a complete previous comment, it makes threads hard to read.
Follow communication policies and best practices
Before you send or post your question:
- Read and follow the code of conduct for Wikimedia technical spaces.
- Use 包括的言語 : Instead of using terms that assume a gender identity (like "guys", "madam", or "sir") use the name of the person instead.
Ask in the right place
- Ask in public: Do not send private messages if your conversation topic is not secret.
Private messages don't help others.
- Ask and discuss in the best place:
- In Phabricator tasks, discuss only specific questions about the topic of that task.
- Ask general technical questions, like how to set up a development environment or how to fix problems with Gerrit, in the places listed on コミュニケーション .
- If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.
Be patient
After you post your question:
- Do not ask people for code review in a separate message. People receive Gerrit and Phabricator notifications and will respond when they can.
- When seeking input and comments, especially during weekends and holidays, you may need to wait until business hours resume. On chat channels like IRC: if nobody answers, try again at a different time; don't just give up!
- If you don't get an answer even after waiting and being patient, consider if other Communication channels might be a better place to ask your question.
その他のリソース
- Introduction to the Wikimedia Technical Ecosystem provides an overview of Wikimedia tech, focused on the major areas where developers can contribute.
- 貢献する方法 - 説明文書やテストなどの分野を含む、より多くの貢献の方法を列挙しています。
- MediaWiki のハッカーになる方法: MediaWiki のコアまたはその拡張機能で作業をしたい開発者向け。
- Newbie guide for the Web team
- 開発者向けハブ: 実績のあるウィキメディア開発者向けのリソース集。
- 質問をしたり、全般的な議論に参加するには、コミュニケーションに列挙されている場所を確認してください。
- Wikimedia tutorials: An index of tutorials that feature various languages, APIs, and frameworks in the Wikimedia technology stack.
- Supporting newcomers at hackathons
- Newcomer support at hackathons and the associated mentor guide
- Newcomers section of the Hackathons Handbook, as well as the Mentoring Tips page
- How-to page for newcomers at the Wikimedia Hackathon 2022