כיצד להפוך למתכנת מדיה־ויקי

ערך זה נכתב כדי לעזור למפתחים ללמוד את הכישורים הבסיסיים הדרושים כדי לתרום לפיתוח של ליבת מדיה־ויקי וההרחבות של מדיה־ויקי.

תרומה למדיה־ויקי היא לעתים קרובות קשה, לכן אם תרצו להיות מעורבים בפיתוח ויקימדיה במקום זאת, עליכם לתרום למיזמי ויקימדיה המציעים חונכות. חלופה ללא חונכות היא לתקן באג מומלץ למתחילים.

אם אתה מפתח מנוסה שכבר מכיר את השימוש במדיה־ויקי, בקר במרכז המפתחים במקום זאת.

לדרכים נוספות להצטרף לקהילת ויקימדיה, ראו איך לתרום .

Most of MediaWiki and extensions are written in the PHP programming language. JavaScript is used for providing interactive interface elements along with jQuery and Vue.js as client JavaScript libraries.

Some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python.

MediaWiki is primarily written for the LAMP platform^[1] and runs on most operating systems. MediaWiki primarily uses the MySQL or MariaDB database servers.^[2]

The main developer list is wikitech-l. The main developer IRC channels are #mediawiki ^connect and #wikimedia-dev ^connect.

Follow this tutorial to set up Git and Gerrit in order to submit patches.

Before you ever develop a feature or fix a bug in a MediaWiki project, it is important that you do your research about it. This includes:

1. Search Phabricator if an open or closed Task (Document Types field) already exists. If it doesn't, create one. If this is a very small change, don't create one.
2. Find and investigate the code that needs to be changed to implement the feature. Comment your findings on the Phabricator Task if they might be helpful to others who implement it or review your changes.
3. Determine if you can likely add the feature or fix the bug based the code you investigated and the changes needed. If the task is large or complex, you should find something easier and work your way up to eventually be able to handle tasks of that size. If you believe you can complete it, assign yourself to the Task and begin working on it.

Docker is a good option if you want to set up a MediaWiki installation quickly and are not planning on installing many extensions. MediaWiki Docker provides an easy way to spin up containerized MediaWiki environments that you can use for basic testing. If you experience slowness using MediaWiki Docker, a local installation may be a better option.

• התחלה מהירה לפיתוח מקומי – Run MediaWiki locally using PHP and Composer.

Local installation is a good option if you want to set up a simple development environment quickly without using Docker. A local installation can help you learn how MediaWiki works and get started as a contributor.

The two recommended code editors for editing MediaWiki are VSCode and PhpStorm . VSCode is free and PhpStorm is paid, however, you can acquire a PhpStorm license for free if you are a student by linking your GitHub Education account to your JetBrains account, or by requesting a license granted to Wikimedia.

To determine which editor you should install and use, know that all-around, PhpStorm has more and more-powerful features than VSCode. However, PhpStorm takes significantly longer to load on start than VSCode as it builds an index of the entire repository whereas VSCode progressively loads. Therefore, VSCode is typically useful for file-viewing sessions or small changes and PhpStorm for larger changes. It makes sense to have both installed for these reasons.

Change the code and view your changes by reloading your MediaWiki browser tab. Make sure to follow Manual:Coding conventions . Write and run tests on your code to make sure it works and is formatted properly.

Note, you can save time by ensuring your changes will be accepted before taking the time to write tests. Create a patch without needed tests and ask for someone to review it stating that you will add tests after they review it.

בצעו את העצות הבאות כדי לתקשר ביעילות ולקבל עזרה מחברי הקהילה.

כאשר אתם מתכננים לעבוד על משימת Phabricator :

• אין צורך לבקש רשות: תוכלו לעבוד על משימות שלא הוקצו מבלי לבקש מאף אחד להקצות לך אותן. אין סמכות שמקצה משימות או את מי צריך לשאול קודם.
  • אם למשימה כ��ר יש תיקון עדכני ב־Gerrit, בחר משימה אחרת לעבוד עליה במקום זאת.
  • אם תיקון קיים ב־Gerrit שלא מוזג ושלא ראה שינויים במשך זמן רב, ניתן לשפר את התיקון הקיים, בהתבסס על המשוב ב־Gerrit ובמשימה.
• בדקו את הנושא בעצמכם: כשאתם שוקלים לעבוד על משימה, בצעו מחקר לפני שאתם מתחילים לכתוב קוד. התבוננו בקוד, נסו להבין מה הוא אמור לעשות, קראו תיעוד רלוונטי ונסו למצוא את המקומות שבהם אתם צריכים לבצע שינויים בקוד.
  • במשימת Phabricator , השתמש בתגיות הפרויקט בסרגל הצד כדי למצוא את מאגר הקוד עבור המשימה.
  • אם אין לכם מושג איך לתקן את הבאג, שקלו למצוא תחילה דרך קלה יותר.
• אינכם צריכים להכריז על התוכניות שלכם לפני שאתם מתחילים לעבוד על משימה, אך עליכם להודיע שאתם עובדים עליה.
  • כשאתם מתחילים לעבוד, הגדירו את עצמכם כמקבלי המשימה על ידי לחיצה על עריכת משימה… ב־Phabricator, והגדירו את שם המשתמש שלכם ב־Phabricator בשדה הוקצה ל־. זה מעביר לאחרים את המסר שאתם עובדים עליה, כדי שלא יעשו עבודה כפולה.
  • כאשר התוכניות או תחומי העניין שלכם משתנים: אם אינכם עובדים עוד על משימה, הסירו את עצמכם כמקבלי המשימה. זה אומר לאחרים שהם יכולים לעבוד על המשימה, והם לא יצפו ממכם להמשיך לעבוד עליה.
• יש להקפיד על כללי הנימוס של הפבריקטור.
  • במשימות פבריקטור, יש לדון רק בשאלות ספציפיות בנוגע לנושא המשימה. אל תשתמשו בפבריקטור כדי לשאול שאלות כלליות, כמו כיצד להגדיר סביבת פיתוח או כיצד לתקן בעיות עם Gerrit.

• אל תבקשו לשאול... פשוט תשאלו!.
• היו ספציפיים וספקו הקשר: במקום פשוט לשאול "האם תוכל לתת לי מידע נוסף?", "אנא תן לי הדרכה" או "אנא ספר לי איך להתחיל", כללו את המידע הבא בשאלתכם:
  • מה אתם מנסים להשיג?
  • מה כבר ניסיתם? העתיקו והדביקו את הפקודות שלכם ואת הפלט שלהן (אם הן לא ארוכות מדי) במקום לנסח אותן מחדש במילים שלכם.
  • מה כבר גיליתם במהלך המחקר שלכם? כללו קישורים לקוד, תיעוד או משאבים אחרים שכבר עיינתם בהם.
• השתמשו בכותרות ובשורות נושא ספציפיות בתקשורת שלכם. "טיוטת הצעה" או "זקוק לעזרה" אינם ספציפיים.
• שמרו על שיחות קריאות: כשאתם משיבים ב־Zulip, במשימות של Phabricator, או ברשימות תפוצה, צטטו רק קטעים מתגובות קודמות הרלוונטיים לתגובתכם. אם אתם מצטטים תגובה קודמת שלמה, זה מקשה על קריאת השרשורים.

לפני שאתם שולחים או מפרסמים את שאלתכם:

• קראו ופעלו לפי קוד ההתנהגות למרחבים הטכניים של ויקימדיה.
• השתמשו בinclusive language : במקום להשתמש במונחים המניחים זהות מגדרית (כמו "חברה", "גברתי" או "אדוני") השתמשו בשם האדם במקום זאת.

• שאלו בפומבי: אל תשלחו הודעות פרטיות אם נושא השיחה אינו סודי. הודעות פרטיות לא עוזרות לאחרים.
• שאלו ודונו במקום הטוב ביותר:
  • במשימות פבריקטור, יש לדון רק בשאלות ספציפיות בנוגע לנושא המשימה.
  • שאלו שאלות טכניות כלליות, כמו כיצד להגדיר סביבת פיתוח או כיצד לתקן בעיות עם Gerrit, במקומות המפורטים בדרכי תקשורת .
  • אם אתם משתתפים בתוכנית הסברה, אז Zulip מיועד לדיון בשאלות בנוגע לתוכניות ההסברה עצמן.

לאחר פרסום שאלתכם:

• אל תבקשו מאנשים סקירת קוד בהודעה נפרדת. אנשים מקבלים התראות מ־Gerrit וה־Phabricator ויגיבו כשהם יכולים.
• כשאתם מבקשים משוב והערות, במיוחד בסופי שבוע ובחגים, ייתכן שתצטרכו להמתין עד לחידוש שעות הפעילות. בערוצי צ'אט כמו IRC: אם אף אחד לא עונה, נסו שוב בזמן אחר; אל תוותרו!
• אם לא קיבלתם תשובה גם לאחר המתנה וסבלנות, שקלו אם ערוצי תקשורת אחרים עשויים להיות מקום טוב יותר לשאול את שאלתכם.

Learn PHP

• PHP tutorial — Available in many different languages. If you have no knowledge of PHP but know how to program in other object-oriented programming languages, PHP will be easy for you to learn.
• PHP Programming at Wikibooks.
• PHP at Wikiversity.

PHP resources

• The PHP manual — Available in many different languages.
• PHP coding conventions within the MediaWiki community.

Stuff to know

• The script maintenance/eval.php in MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.
• Also, the script maintenance/shell.php in MediaWiki is a replacement of maintenance/eval.php based on PsySH, see Manual:Shell.php

Learn MySQL/MariaDB

• MySQL tutorial — From the MySQL reference manual.
• MySQL at Wikibooks.

MySQL/MariaDB resources

• MySQL Reference Manuals — Available in many different languages.
• MariaDB Knowledge Base
• Database coding conventions within the MediaWiki community.
• Accessing the database

Stuff to know

• Test your code with MySQL/MariaDB.
  • MediaWiki currently uses MySQL and MariaDB as the primary database back-end. It also supports other DBMSes, such as PostgreSQL and SQLite. However, almost all developers use MySQL/MariaDB and don't test other DBs, which consequently break on a regular basis. You're therefore advised to use MySQL/MariaDB when testing patches, unless you're specifically trying to improve support for another DB. In the latter case, make sure you're careful not to break MySQL/MariaDB (or write queries that are horribly inefficient in it), since MySQL/MariaDB is what everybody else uses.

JavaScript and CSS have become omnipresent in front-end code. You don't have to be familiar with JavaScript, jQuery and CSS to work on MediaWiki, but you might need to, depending on what you choose to work on.

Learn JavaScript and CSS

• JavaScript and CSS at Wikibooks.
• Getting Started with jQuery — A jQuery tutorial.
• Learning JavaScript — references and sources.

JavaScript and CSS resources

• JavaScript coding conventions within the MediaWiki community.
• CSS coding conventions within the MediaWiki community.

The MediaWiki code base is large and some parts are ugly; don't be overwhelmed by it. When you're first starting off, aim to write features or fix bugs which only touch a small region of code.

MediaWiki basics and must-reads

• MediaWiki architecture — A high-level overview of the main components of MediaWiki and how they work with each other.
• Security for developers — An overview of why and how to write secure code.

MediaWiki resources

• Manual:Code — A list of important files and links to more detailed information.
• Manual:Hooks — A list of hooks. If you're trying to find what part of the codebase does something, often a good place to start is by searching for the related hooks.
• Manual:Coding conventions — An overview of general coding conventions within the MediaWiki community.
• Code documentation (class reference) — Automatically generated documentation from the code and code comments.
• Manual:How to debug — A guide to debugging MediaWiki.
• Manual:Eval.php — A tool to interact with MediaWiki objects live.

MediaWiki extensions basics:

• Developing extensions — How to write an extension for MediaWiki.
• Extension writing tutorial

MediaWiki extensions resources:

• Best practices for extensions
• A brief introduction to MediaWiki extension development — A video presentation about how to create a MediaWiki extension (slides).
• Making a MediaWiki extension — Covers how to develop an extension for MediaWiki, best practices, and how to engage the MediaWiki community. From February 2011.
• Help for extension developers on the Developer Hub

• חיפוש קוד במאגרים שונים
• מרכז המפתחים – When you've thoroughly read the information in this article, it's time to move on to the information in the developer hub.
• קוד התנהגות