How to become a MediaWiki hacker/vi

Mục này được viết nhằm giúp những nhà phát triển tìm hiểu những kỹ năng cần thiết để góp phần vào sự phát triển của Những phần quan trọng nhất của MediaWiki và phần mở rộng của MediaWiki.

Con đường chính để bắt đầu với Wikimedia phát triển là để đóng góp cho  Các dự án Wikimedia cung cấp cố vấn. Một cách khác mà không cần cố vấn là sửa một lỗi đầu tiên.

Nếu bạn là nhà phát triển có kinh nghiệm, xin mời chuyển sang  instead.

Các cách khác để tham gia vào cộng đồng Wikimedia, xem mục 

Giới thiệu
MediaWiki là phần mềm cung cấp Wikipedia, các dự án liên quan và hàng ngàn wikis trên toàn thế giới.

Although MediaWiki is written in the PHP programming language, some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python. Nó sử dụng jQuery làm thư viện JavaScript của máy khách.

MediaWiki chủ yếu được viết cho nền tảng LAMP và chạy trên hầu hết các hệ điều hành. MediaWiki chủ yếu sử dụng các máy chủ cơ sở dữ liệu MySQL hoặc MariaDB.

Sự phát triển xảy ra theo phong cách mã nguồn, phần lớn được điều phối trực tuyến và được hỗ trợ bởi Wikimedia Foundation, mặc dù các nhà phát triển cộng đồng tình nguyện cũng đóng một vai trò rất lớn.

The main developer list is wikitech-l. The main developer IRC channels are and. Follow this tutorial to set up Git and Gerrit in order to submit patches.
 * Development discussion happens on, , and IRC channels.
 * Source code is stored on and managed using the Git revision control system and can be viewed here
 * Code review is performed on and can be viewed here.
 * Bug reports and feature requests are filed, and projects are coordinated on and can be viewed here

Set up your development environment
You can install and develop MediaWiki on Linux, Windows, or macOS using any of the three solutions below.

Trước hết, hãy vào $dev và Special:MyLanguage/Gerrit/Tutorial để tải về bộ mã, kiểm tra nó và gửi các bản vá lỗi. Then you can move on to downloading our code, making changes, testing them, and submitting patches. Có 2 cách để thiết lập môi trường phát triển của bạn: dùng một máy ảo được thiết lập sẵn để cài đặt (Vagrant) hoặc cài đặt bằng tay( cài đặt thủ công)

Docker

 * MediaWiki Docker – Run MediaWiki using Docker.

It can be very slow on Windows if you are using WSL2 based engine, due to the poor performance of its shared directory implementation. You can switch to the Hyper-V backend on the setting of Docker Desktop for better filesystem performance.

You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki Docker containers. With this you can easily add extensions and features to your container.

Máy ảo với công cụ Vagrant


 * MediaWiki Vagrant – Run MediaWiki on a Linux virtual machine using Vagrant.

Vagrant allows you start a MediaWiki instance you can develop as well as allowing you to add and develop any of 250+ extensions - all with a single command. This saves you installation and configuration time compared to manually installing. It runs faster than Docker on Windows however slower than manually installing. You may also experience shared directory performance issues if you are using VirtualBox.

 Cài đặt thủ công MediaWiki can be developed by installing it natively on your system and editing its code. Installing it natively means it will run much faster than Docker or Vagrant, but it will take more time to configure.


 * 1)  — Check hardware requirements and install dependencies
 * 2)  — Tải về mã nguồn mới nhất từ Git.
 * 3)  — Tiếp tục với việc cài đặt và thiết lập ban đầu
 * 4) * Cài đặt various debug modes trong môi trường của bạn để hiển thị cảnh báo và các lỗi sớm

PHP
MediaWiki is written in PHP, so you'll need to get familiar with PHP to hack MediaWiki's core.


 * 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  in MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.
 * Also, the script  in MediaWiki is a replacement of   based on PsySH, see

Database
Many features require some amount of database manipulation, so you'll often need to be familiar with MySQL/MariaDB.


 * 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.


 * 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
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.

MediaWiki
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 :
 *  — A high-level overview of the main components of MediaWiki and how they work with each other.
 *  — An overview of why and how to write secure code.


 * MediaWiki resources :
 * — A list of important files and links to more detailed information.
 * — 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.
 * — An overview of general coding conventions within the MediaWiki community.


 * Code documentation ( class reference ) — Automatically generated documentation from the code and code comments.
 * — A guide to debugging MediaWiki.
 * — A tool to interact with MediaWiki objects live.

MediaWiki extensions
If you choose to work on MediaWiki extensions code, the following links provide more information.


 * 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