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.

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

Find or create a task
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.

Set up your development environment
Once you have found something you can work on, the next step to developing MediaWiki or an extension is creating an environment to run MediaWiki, its database, and any other external features so that you can develop and test them.

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

Docker

 * MediaWiki Docker – Chạy MediaWiki bằng cách sử dụng Docker.

Docker is a good option if you want to setup a MediaWiki installation quickly and are not planning on installing many extensions.

Bạn cũng có thể dùng thử nghiệm công cụ mwcli để thiết lập Docker bằng một vài lệnh đơn giản và cung cấp chức năng điều phối cơ bản cho bộ chứa Docker của MediaWiki.

Vagrant

 * MediaWiki Vagrant – Chạy MediaWiki trên máy ảo Linux bằng Vagrant.

Vagrant cho phép bạn bắt đầu một phiên bản MediaWiki mà bạn có thể phát triển cũng như cho phép bạn thêm và phát triển bất kỳ tiện ích mở rộng nào trong số hơn 250 tiện ích mở rộng - tất cả chỉ bằng một lệnh.

Điều này giúp bạn tiết kiệm thời gian cài đặt và cấu hình so với cài đặt thủ công.

 Cài đặt thủ công

MediaWiki can be developed by installing it and its dependencies locally on your system.

It will take much more time to set up than Docker or Vagrant.


 * 1)  — Kiểm tra yêu cầu phần cứng và cài đặt phụ thuộc
 * 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) Thiết lập các chế độ gỡ lỗi khác nhau trong môi trường của bạn để sớm hiển thị cảnh báo và lỗi.

Open a code editor
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 use, know that all-around, PhpStorm has more and more-powerful features than VSCode, however, you may not want to become "tied" to it and instead it may be beneficial to learn and expose yourself to the ever-growing ecosystem of VSCode and its extensions. Additionally, 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.

To develop the MediaWiki codebase that is inside a Docker container you can establish a remote connection to it and open the MediaWiki folder inside it using VSCode or PhpStorm.

Change and test the code
Change the code and view your changes by reloading your MediaWiki browser tab. Make sure to follow. 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.

Create a patch
Finally, to submit your code to be reviewed and added to the repository you are contributing to, follow.



PHP
MediaWiki được viết bằng PHP, vì vậy bạn sẽ cần làm quen với PHP để hack lõi của MediaWiki.


 * Học PHP
 * PHP hướng dẫn — Có sẵn trong nhiều ngôn ngữ khác nhau. Nếu bạn không có kiến ​​thức về PHP nhưng biết cách lập trình bằng các ngôn ngữ lập trình hướng đối tượng khác, PHP sẽ rất dễ dàng để bạn học.
 * Lập trình PHP tại Wikibooks.
 * PHP tại Wikiversity.


 * PHP tài nguyên:
 * Sổ tay PHP — Có sẵn trong nhiều ngôn ngữ khác nhau.
 * Quy ước mã hóa PHP trong cộng đồng MediaWiki.


 * Những điều cần biết:
 * Tập lệnh  trong MediaWiki cung cấp một trình thông dịch PHP cơ bản với các đối tượng và lớp MediaWiki được tải.
 * Ngoài ra, tập lệnh  trong MediaWiki là sự thay thế của   dựa trên PsySH, xem

Cơ sở dữ liệu
Nhiều tính năng yêu cầu một số lượng thao tác với cơ sở dữ liệu, vì vậy bạn thường cần phải làm quen với MySQL/MariaDB.


 * Tìm hiểu MySQL/MariaDB
 * MySQL Hướng dẫn — Từ MySQL hướng dẫn tham khảo.
 * MySQL tại Wikibooks.


 * MySQL/MariaDB tài nguyên
 * MySQL Tài liệu tham khảo — Có sẵn trong nhiều ngôn ngữ khác nhau.
 * MariaDB Kiến thức Cơ bản
 * Quy ước mã hóa cơ sở dữ liệu trong cộng đồng MediaWiki.


 * Những điều cần biết:
 * Kiểm tra mã của bạn với MySQL/MariaDB.
 * MediaWiki hiện đang sử dụng MySQL và MariaDB làm nền tảng cơ sở dữ liệu chính. Nó cũng hỗ trợ các DBMS khác, chẳng hạn như PostgreSQL và SQLite. Tuy nhiên, hầu hết tất cả các nhà phát triển đều sử dụng MySQL/MariaDB và không kiểm tra các DB khác, do đó thường xuyên bị hỏng. Do đó, bạn nên sử dụng MySQL/MariaDB khi kiểm tra các bản vá, trừ khi bạn đang cố gắng cải thiện hỗ trợ cho một DB khác. Trong trường hợp sau, hãy đảm bảo rằng bạn cẩn thận để không phá vỡ MySQL/MariaDB (hoặc viết các truy vấn cực kỳ kém hiệu quả trong đó), vì MySQL/MariaDB là thứ mà mọi người khác sử dụng.



JavaScript và CSS
JavaScript và CSS đã trở nên phổ biến trong mã giao diện người dùng. Bạn không phải quen thuộc với JavaScript, jQuery và CSS để làm việc trên MediaWiki, nhưng bạn có thể cần, tùy thuộc vào những gì bạn chọn để làm việc.


 * 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

MediaWiki skins
is helpful if you choose to work on MediaWiki skins.