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

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

Hầu hết các dự án sử dụng Git và Gerrit. Làm theo Gerrit hướng dẫn để thiết lập tài khoản nhà phát triển của bạn. Sau đó bạn có thể chuyển sang tải xuống mã của chúng tôi, thực hiện các thay đổi, kiểm tra chúng và gửi các bản vá. Có hai cách để thiết lập môi trường phát triển của bạn: sử dụng thiết lập máy ảo được định cấu hình sẵn (Docker hoặc Vagrant) hoặc phương pháp cấu hình thủ công.

Docker

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

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. Với điều này bạn có thể dễ dàng thêm tiện ích mở rộng và tính năng vào vùng chứa của mình.

Nếu bạn chạy nó từ Windows, Docker sẽ chia sẻ các tệp giữa hệ thống tệp Windows của bạn và hệ thống tệp vùng chứa. Điều này có thể khiến MediaWiki rất chậm nếu bạn đang sử dụng công cụ dựa trên WSL2, do hiệu suất triển khai thư mục dùng chung kém. Nếu bạn có Windows Pro, bạn có thể chuyển sang chương trình phụ trợ Hyper-V trong cài đặt của Docker Desktop để có hiệu suất hệ thống tệp tốt hơn.

Một cách thậm chí còn nhanh hơn để chạy MediaWiki bằng Docker trong Windows (tốc độ tương đương với cài đặt thủ công) là sao chép MediaWiki và chạy Docker bên trong WSL (hoặc cài đặt và chạy  bên trong WSL). Bằng cách đó, không có chi phí hệ thống tệp được chia sẻ. Để phát triển cơ sở mã MediaWiki bên trong bộ chứa Docker, bạn có thể thiết lập kết nối từ xa với nó và mở thư mục MediaWiki WSL trong bộ chứa đó bằng cách sử dụng VSCode hoặc PhpStorm.

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. Nó chạy nhanh hơn Docker trên Windows, tuy nhiên chậm hơn so với Docker trên WSL hoặc cài đặt thủ công.

 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 faster than Docker or Vagrant, but it will take more time to configure.


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



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
Manual:How to make a MediaWiki skin is helpful if you choose to work on MediaWiki skins.