新規開発者

From mediawiki.org
This page is a translated version of the page New Developers and the translation is 67% complete.
Outdated translations are marked like this.

This page explains how to get started as a developer who wants to contribute to Wikimedia technical projects.

ようこそ!

Wikimedia Hackathon 2019 の集合写真

ウィキメディアの技術コミュニティは、いつも新人の参加を歓迎しています。

グローバルなコミュニティにぜひ参加して、フリーな知識へ誰でも楽にアクセスできるようにしましょう!

How to start contributing

The following steps are a general outline of how to get started contributing:

  1. Learn the basics of how Wikimedia open source software projects work.
  2. Read the Communication guidelines.
  3. Set up accounts: Create a developer account. Depending on the type of contribution you want to make, you may also need to set up accounts in Phabricator, and set up Git and Gerrit.
  4. ソフトウェアプロジェクトを選択する
  5. タスクを選んで解決 ( コードを書きテストする)
  6. レビューのためにコード変更を提出する。 Follow the Guide to getting your code reviewed and submit a patch.

The rest of this guide provides additional details about the process.

Basics of how Wikimedia software projects work

ウィキメディアには多くの分野にソフトウェア プロジェクトがあります。

ソフトウェア・プロジェクトにはそれぞれ管理者がいて、どのインフラ環境を使うか自由に選んでいます。一般論として、どのソフトウェア・プロジェクとにも以下の基本条件が揃っています。

  • 提案されたコード変更(いわゆるパッチ)が議論されて改善されるコード レビュー ツールです。例としては、ウィキメディアの Git/Gerrit、GitHub、Sourceforge などがあります。あなたの提案したパッチが適切であり、コード リポジトリにマージされた場合は、あなたのコード変更は誰でも利用できるようになります。(コード レビューの成功事例についてはこちらを参照してください。)
  • ソフトウェア プロジェクトについて 議論する 一般的な 場所 であり、ヘルプやサポートの場所です。これらの場所には、メーリング リストや IRC チャット チャンネル、ウィキ ページ、その他の場所があります。具体的な場所は、各プロジェクトによって異なります。

問題が発生したり、助けが必要な場合は、いつでも質問してください。適切な場所で適切な質問をしたい場合は、「フィードバック、質問、サポート」の節を読むことをお勧めします。

ソフトウェアプロジェクトを選択する

以下のプロジェクトは、リソースやメンター制度を提供し、貢献してくれる新しい開発者を募集しています。 以下のいずれかのプロジェクトを選択し、プロジェクトのドキュメントに従って開発環境を設定し、作業するタスクを選択し、タスクを解決し、コードの変更をレビューに提出します。 これらのプロジェクトや、ウィキメディアに関連する他のプロジェクトに自由に貢献することができます。 Most can be found by searching for them on Phabricator or online.

Kiwix

Screenshot

An offline reader for people without internet access

Android用のコモンズアプリ

Screenshot

画像をウィキメディアコモンズにアップロードするAndroid アプリ

Wiki Education Dashboard

Screenshot

A web application that supports Wikipedia education assignments, provides data and course management for instructors and students

Logo Pywikibot

Terminal

A Python library and collection of scripts that automate work on MediaWiki sites.

Scribe

Scribe features

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!

Logo VideoCutTool

VideoCutTool

A tool to edit the videos on Wikimedia Commons.

あなたはメンテナーで、プロジェクトを上記のソフトウェアプロジェクトのリストに入れたいと思っていますか?詳細をご覧になり、ご参加ください!

普及プログラムと単体のタスク

In addition to the recommended software projects above, there are more ways to choose a project or task to work on:

Logo アウトリーチ プログラム

ウィキメディア財団ではインターン制度を提供しており、その例がたとえば Google Summer of Code や Outreachy です。

Logo 入門向けのタスク

新人開発者向きの単体のタスクも (さまざまなソフトウェアのプロジェクトで) 多く用意されています。
しかしながら、ここではどちらかというと自分で自分の道を切り開くスタイルが標準的です: 指導役が見つかる約束はありませんし、皆さんが提案したパッチがすぐに評価をして貰えるとも限りません。

Communication tips

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:

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.

その他のリソース

  • To ask your questions and to join general discussions, check the places listed on Communication.
  • Wikimedia tutorials: An index of tutorials that feature various languages, APIs, and frameworks in the Wikimedia technology stack.