কিভাবে একজন মিডিয়াউইকি হ্যাকার হবেন

This article is written to help developers learn the basic skills needed to contribute to development of MediaWiki core and MediaWiki extensions.

Wikimedia বিকাশের সাথে শুরু করার প্রধান পথ হল উইকিমিডিয়া প্রকল্পগুলিতে অবদান রাখা যা পরামর্শ প্রদান করে'। পরামর্শ ছাড়া একটি বিকল্প হল একটি ভাল প্রথম বাগ ঠিক করা।

আপনি যদি একজন অভিজ্ঞ ডেভেলপার হন যিনি ইতিমধ্যেই মিডিয়াউইকি ব্যবহার করতে জানেন, তাহলে তার পরিবর্তে Developer hub -এ যান।

উইকিমিডিয়া সম্প্রদায়ে জড়িত হওয়ার অন্যান্য উপায়ের জন্য, কীভাবে অবদান রাখবেন দেখুন।

একনজরে

মিডিয়াউইকি হলো এমন একটি সফটওয়্যার যা উইকিপিডিয়া ও এর সহপ্রকল্পসমূহ এবং সারা বিশ্বের হাজার হাজার উইকিসাইটকে পরিচালনার ক্ষমতা দেয়।

মিডিয়াউইকি পিএইচপি ভাষায় লিখিত। এটি ক্লায়েন্ট জাভাস্ক্রিপ্ট লাইব্রেরি হিসাবে jQuery ব্যবহার করে।

মিডিয়াউইকি প্রাথমিকভাবে LAMP প্ল্যাটফর্ম এবং বেশিরভাগ অপারেটিং সিস্টেমে চলে। মিডিয়াউইকি প্রাথমিকভাবে MySQL বা MariaDB ডাটাবেস সার্ভার ব্যবহার করে।

বিকাশ একটি ওপেন সোর্স স্টাইলে ঘটে, মূলত অনলাইনে সমন্বিত, এবং উইকিমিডিয়া ফাউন্ডেশন দ্বারা সমর্থিত, যদিও স্বেচ্ছাসেবী সম্প্রদায় বিকাশকারীরাও একটি বিশাল ভূমিকা পালন করে।

• উন্নয়ন আলোচনা বিভিন্ন মেলিং তালিকা এবং আইআরসি চ্যানেলে হয়।

প্রধান উন্নয়নকারীগণের তালিকা হলো wikitech-l। প্রধান বিকাশকারী IRC চ্যানেলগুলি হল #mediawiki ^connect এবং #wikimedia-dev ^connect৷

• সোর্স কোড Gerrit এ সংরক্ষণ করা হয় এবং Git রিভিশন কন্ট্রোল সিস্টেম ব্যবহার করে পরিচালিত হয় এবং দেখা যায়। /core এখানে
• কোড পর্যালোচনা Gerrit -এ সম্পাদিত হয় এবং এখানে দেখা যায়। Follow this tutorial to set up Git and Gerrit in order to submit patches.

• বাগ রিপোর্ট' ফাইল করা হয় এবং 'প্রকল্প' সমন্বিত হয় ফ্যাব্রিকেটর এবং দেখা যায় এখানে

আপনার উন্নয়নের পরিবেশ তৈরী করুন

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

বেশিরভাগ প্রকল্প গিট এবং গেরিট ব্যবহার করে। আপনার ডেভেলপার অ্যাকাউন্ট সেট আপ করতে Gerrit টিউটোরিয়াল অনুসরণ করুন। Then you can move on to downloading our code, making changes, testing them, and submitting patches. আপনার ডেভেলপমেন্ট এনভায়রনমেন্ট সেট আপ করার দুটি উপায় আছে: একটি প্রাক-কনফিগার করা ভার্চুয়াল মেশিন সেটআপ (ডকার বা ভ্যাগ্রান্ট), অথবা একটি ম্যানুয়াল কনফিগারেশন পদ্ধতি ব্যবহার করে।

ডকার উন্নয়নের পরিবেশ

• MediaWiki Docker – Run MediaWiki using Docker.

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

If you run it from Windows, Docker shares files between your Windows filesystem and the container filesystem. This can cause MediaWiki to be very slow if you are using WSL2 based engine, due to the poor performance of its shared directory implementation. If you have Windows Pro, you can switch to the Hyper-V backend in the settings of Docker Desktop for better filesystem performance.

An even faster way to run MediaWiki using Docker in Windows (speeds comparable to manually installing) is to clone MediaWiki and run Docker inside WSL (or install and run mwcli inside of WSL). That way there is no shared filesystem overhead. To develop the MediaWiki codebase that is inside the Docker container you can establish a remote connection to it and open the MediaWiki WSL folder in that is in the container using VSCode or PhpStorm.

ভ্যাচারুয়াল ভার্চুয়াল মেশিন

• 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 Docker on WSL or manually installing.

ম্যানুয়াল ইনস্টল প্রক্রিয়া

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. ম্যানুয়াল:ইনস্টলেশনের জন্য প্রয়োজন — Check hardware requirements and install dependencies
2. গিট থেকে ডাউনলোড করুন — গিট থেকে সর্বশেষ সোর্স কোডটি ডাউনলোড করুন
3. নির্দেশিকা:ইনস্টলকরণ নির্দেশিকা — Continue with the installation and initial configuration.
4. Set up the various debug modes in your environment to display warning and errors early.

যোগাযোগের টিপস এবং গাইডলাইন

A developer fixes a bug in a MediaWiki extension, including investigation, git commit, getting it reviewed and merged, and closing the Bugzilla ticket (now replaced by ফ্যাব্রিকেটর ).

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 ফ্যাব্রিকেটর 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 যোগাযোগ .
  • 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.

পরিশিষ্ট

MediaWiki contributors at work in Bangalore, India.

PHP

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

পিএইচপি শিখুন

• পিএইচপি টিউটোরিয়াল — অনেকগুলো ভিন্ন ভিন্ন ভাষাতে উপলব্ধ। 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 coding conventions within the MediaWiki community.

স্টাফ জানার জন্য

• 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 of maintenance/eval.php based on PsySH, see Manual:Shell.php

তথ্যভান্ডার

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

মাই এসকিউএল/মারিয়াডিবি শিখুন

• মাই এসকিউএল টিউটোরিয়াল — 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.
• কীভাবে ডাটাবেস অ্যাক্সেস করবেন

স্টাফ জানার জন্য

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

জাভাস্ক্রিপ্ট ও সিএসএস শিখুন

• JavaScript and CSS at Wikibooks.
• জে-কোয়েরি দিয়ে শুরু করা — একটি জে-কোয়েরি টিউটোরিয়াল।
• 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

• ম্যানুয়াল:কোড — 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.

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.

আরও দেখুন

• 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.
• আচরণবিধি