কিভাবে একজন মিডিয়াউইকি হ্যাকার হবেন
This article is written to help developers learn the basic skills needed to contribute to development of MediaWiki core and MediaWiki extensions. Note that in most cases when working with MediaWiki, you do not want to hack MediaWiki core unless you really know what you're doing.
If you are an experienced developer who is familiar with using MediaWiki already, visit the Developer hub instead.
For other ways to get involved in the Wikimedia community, see কিভাবে অবদান রাখবেন.
মিডিয়াউইকি হলো এমন একটি সফটওয়্যার যা উইকিপিডিয়া ও এর সহপ্রকল্পসমূহ এবং সারা বিশ্বের হাজার হাজার উইকিসাইটকে পরিচালনার ক্ষমতা দেয়।
- Code review is performed on Gerrit.
Follow this tutorial to set up Git and Gerrit in order to submit patches.
- Bug reports and tasks are managed on Phabricator.
এই পৃষ্ঠাটি আপনাকে মিডিয়াউইকিতে একজন অবদানকারী হতে সাহায্য করবে। It is not a tutorial; it just points you to various places where you can go learn whatever is necessary.
আপনার উন্নয়নের পরিবেশ তৈরী করুন
Most projects use Git and Gerrit. Follow the Gerrit tutorial to set up your developer account. Then you can move on to downloading our code, making changes, testing them, and submitting patches. There are two ways to set up your development environment: using a pre-configured virtual machine setup (Vagrant or Docker), or a manual configuration approach.
ভ্যাচারুয়াল ভার্চুয়াল মেশিন
- Vagrant installation — These steps will install MediaWiki server with all the requirements inside a Linux virtual machine (can be used on Linux, Windows, or Mac hosts).
ডকার উন্নয়নের পরিবেশ
- MediaWiki Docker – Run MediaWiki using Docker (can be used on Linux, Windows or macOS hosts).
ম্যানুয়াল ইনস্টল প্রক্রিয়া
- Installation requirements — Check hardware requirements, and install a LAMP, MAMP or WAMP server (Linux, Mac or Windows, plus Apache, MySQL/MariaDB and PHP).
- Download from Git — * $download— গিট থেকে সর্বশেষ সোর্স কোডটি ডাউনলোড করুন
- নির্দেশিকা:ইনস্টলকরণ নির্দেশিকা — Continue with the installation and initial configuration.
- Set up the various debug modes in your environment to display warning and errors early.
It's not necessary to download Wikipedia database dumps in order to develop MediaWiki features. In fact, in many cases it's easier to use a near-empty database with a few specially-crafted test pages. However, if for some reason you want to have a copy of Wikipedia, you can get a dump.
যোগাযোগের টিপস এবং গাইডলাইন
- Do your research first: When you decide to work on a task, you are expected to do some basic research yourself first: Look at the code, try to get some understanding what it is supposed to do, read related documentation, try to find the probable place(s) where you need to make code changes. For a general overview, please read the Basics to know.
- In a ফ্যাব্রিকেটর task, see the project tags in the side bar to find out which code repository a task is about.
- Ask and discuss in the best place:
- In Phabricator tasks, discuss only specific questions about the topic of that very Phabricator task. General technical questions (e.g. how to set up a development environment or problems with Gerrit) are off-topic in Phabricator tasks.
- For general technical questions, ask the broader Wikimedia community and use generic channels like IRC chat or mailing lists. (If you take part in an outreach program, then you can also use Zulip's technical-support stream.)
- If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.
- Ask good questions: "Can you give me more info?", "Please guide me", "Please tell me how to start" are not good comments to start with: The more specific your questions are, the more likely somebody can answer them quickly. If you have no idea at all how to fix the bug, maybe that bug is not (yet) for you – consider finding an easier one first.
- Provide context: When asking, explain what you want to achieve, and what you have tried and found out already, so others can help at the right level. Be specific – for example, copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words. This avoids misunderstandings. Use specific titles and subject lines ("Proposal draft" or "Need help" is not specific).
- Use inclusive language: Don't assume anyone's gender identity ("guys", "madam", "sir"). Use the name of the person instead.
- Ask in public: Do not send private messages if your conversation topic is not secret. Private messages do not help others.
- Be patient when seeking input and comments, especially during weekends and holidays.
- On IRC, don't ask to ask, just ask: most questions can be answered by other community members too if you ask on an IRC channel. If nobody answers, please try again at a different time; don't just give up.
- Do not ask people immediately for code review in a separate message. People receive Gerrit and Phabricator notifications.
- Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, please avoid unneeded quoting of a complete previous comment. Provide sufficient context and keep threads readable.
- Follow the code of conduct for Wikimedia technical spaces.
- When you plan to work on a Phabricator task:
- No need to ask for permission: Usually there is no reason to ask if you can work on something or if somebody could assign a task to you. There is no authority who assigns tasks or who needs to be asked first.
- You do not need to announce your plans before you start working on a task but it would be welcome. At the latest when you are close to proposing a patch for a task, it is good to announce that you are working on it, so that others don't duplicate work: If nobody else is already assigned, set yourself as task assignee by using the Add Action… → Assign/Claim dropdown.
- Tasks with existing patches:
- If a task already has a recent patch in Gerrit, choose a different task to work on instead – avoid duplicating work.
- If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could also improve that existing patch, based on the feedback in Gerrit and in the task.
- When your plans or interests change: If you don't work on a task anymore, please remove yourself as the assignee of the task, so others know that they can work on the task and don't expect you to still work on it.
By communicating clearly and early you get attention, feedback and help from community members.
MediaWiki is written in PHP, so you'll need to get familiar with PHP to hack MediaWiki's core.
- পিএইচপি শিখুন
- পিএইচপির রিসোর্সসমূহ
- স্টাফ জানার জন্য
- The script
maintenance/eval.phpin MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.
- Also, the script
maintenance/shell.phpin MediaWiki is a replacement of
maintenance/eval.phpbased on PsySH, see Manual:Shell.php
- The script
Many features require some amount of database manipulation, so you'll often need to be familiar with MySQL/MariaDB.
- মাই এসকিউএল/মারিয়াডিবি শিখুন
- MySQL/MariaDB resources
- স্টাফ জানার জন্য
- 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.
জাভাস্ক্রিপ্ট ও সিএসএস
- জাভাস্ক্রিপ্ট ও সিএসএস শিখুন
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 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.
- 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.
If you choose to work on MediaWiki extensions code, the following links provide more information.
- MediaWiki extensions basics:
- 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
- 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.
- Not all of MediaWiki is written in PHP. Some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python.
- MediaWiki runs on most platforms that can support PHP, however, the lack of certain utilities or operating system features may limit the functionality or performance of MediaWiki on non-LAMP platforms.
- MediaWiki has support for DBMS other than MySQL and MariaDB, including PostgreSQL, SQLite
- Developers are a mix of volunteers and paid staff (or contractors) for various organizations. For a full list of who works on the MediaWiki code, read the Developers article.
- 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.