Làm thế nào để trở thành một MediaWiki hacker
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. Lưu ý rằng trong hầu hết các trường hợp khi làm việc với MediaWiki, bạn do không muốn hack lõi MediaWiki trừ khi bạn thực sự biết mình đang làm gì.
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 Developer hub instead.
Các cách khác để tham gia vào cộng đồng Wikimedia, xem mục Làm thế nào để đóng góp
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[1] 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. [2]
Sự phát triển xảy ra theo phong cách mã nguồn[3], 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.
- Development discussion happens on various mailing lists and IRC channels.
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.
- Bug reports are filed and projects are coordinated on Phabricator and can be viewed here
Trang này sẽ giúp bạn bắt đầu trên con đường trở thành một cộng tác viên/người đóng góp cho MediaWiki Nó không thuộc về hướng dẫn, nó chỉ hướng bạn đến nhiều nơi nơi mà bạn có thể học hỏi bất cứ thứ gì bạn cần
Set up your development environment
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 development environment
- MediaWiki Docker – Run MediaWiki using Docker (can be used on Linux, Windows, or macOS hosts).
This is the recommended method.
You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki docker containers. Máy ảo với công cụ Vagrant
- Vagrant installation - Bước này sẽ cài đặt máy chủ MediaWiki với tất cả yêu cầu bên trong một máy ảo Linux (có thể dùng trên các host Linux, Windows hoặc Mac)
Vagrant is a powerful tool, but it is more complex and less robust than Docker, and significantly more resource-intensive. It is mainly aimed at developers who need to set up complex, flexible environments, e.g. for testing the interaction of multiple extensions.
Cài đặt thủ công
- Installation requirements - Kiểm tra yêu cầu phần cứng và cài đặt một server LAMP, MAMP hoặc WAMP ( Linux, Mac hoặc Windows, plus Apache, MySQL/MariaDB và PHP).
- Tải về từ Git — Tải về mã nguồn mới nhất từ Git.
- Hướng dẫn sử dụng:Hướng dẫn cài đặt — Tiếp tục với việc cài đặt và thiết lập ban đầu
- 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
Không nhất thiết phải tải về cơ sở dữ liệu Wikipedia để phát triển các đặc tính của MediaWiki. thực tế, trong nhiều trường hợp sẽ dễ dàng hơn khi dùng một cơ sở dữ liệu gần như là trống với một vài trang thử nghiệm thủ công riêng biệt. However, if for some reason you want to have a copy of Wikipedia, you can get a dump.
Communication tips and guidelines
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
- Don't ask to ask...just ask!.
- 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:
- Read and follow the code of conduct for Wikimedia technical spaces.
- Use inclusive language : Instead of using terms that assume a gender identity (like "guys", "madam", or "sir") use the name of the person instead.
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 Liên lạc .
- 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.
Appendix
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
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 ofmaintenance/eval.php
based on PsySH, see Manual:Shell.php
- The script
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.
- 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.
- Test your code with MySQL/MariaDB.
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
-
- 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
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
See also
- Search for code across repositories
- 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.
- Code of Conduct
- ↑ MediaWiki chạy trên hầu hết các nền tảng có thể hỗ trợ PHP, tuy nhiên, việc thiếu một số tiện ích hoặc tính năng hệ điều hành nhất định có thể hạn chế chức năng hoặc hiệu suất của MediaWiki trên các nền tảng không phải LAMP.
- ↑ MediaWiki có hỗ trợ cho DBMS ngoài MySQL và MariaDB, bao gồm PostgreSQL, SQLite
- ↑ Phát triển là sự kết hợp của các tình nguyện viên và nhân viên được trả lương (hoặc nhà thầu) cho các tổ chức khác nhau. Để biết danh sách đầy đủ những người làm việc trên mã MediaWiki, hãy đọc bài viết Developers .
- ↑ Browse the source code and revisions of code repositories at https://phabricator.wikimedia.org/diffusion/ or download the source code to your system by using Gerrit.