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

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 -এ যান।

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

একনজরে

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

মিডিয়াউইকি পিএইচপি ভাষায় লিখিত। 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.

মিডিয়াউইকি প্রাথমিকভাবে 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.
• বাগ রিপোর্ট' এবং 'বৈশিষ্ট্যের অনুরোধ' করা হয়েছে, এবং ফ্যাব্রিকেটর -তে 'প্রকল্প' সমন্বিত করা হয়েছে এবং তা এখানে দেখা যেতে পারে।

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.

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

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.

ডকার

• MediaWiki Docker – Run MediaWiki using Docker.

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

You can also try the mwcli tool which sets up Docker with a few simple commands and provides basic orchestration functionality between MediaWiki, MySQL, ElasticSearch, Memcached, and other types of containers.

ভ্যাগ্রান্ট

• 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 adding extensions in a Docker or local installation, but it runs a bit slower than the other two options.

স্থানীয় ইন্সটল প্রক্রিয়া

• Local development quickstart – Run MediaWiki locally using PHP and Composer.

Local installation is a good option if you want to set up a simple development environment quickly without using Docker.

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 install and use, know that all-around, PhpStorm has more and more-powerful features than VSCode. However, 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 Manual:Coding conventions . 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 Gerrit/Tutorial .

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

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 ফ্যাব্রিকেটর 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।

পিএইচপির রিসোর্সসমূহ

• পিএইচপি ম্যানুয়াল — অনেকগুলো ভিন্ন ভিন্ন ভাষাতে উপলব্ধ।
• 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।

মাইএসকিউএল/মারিয়াডিবি রিসোর্স

• 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

Introduction to MediaWiki core concepts

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.
• ডেভেলপারদের জন্য সুরক্ষা — An overview of why and how to write secure code.

মিডিয়াউইকি রিসোর্স

• ম্যানুয়াল:কোড — 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.
• কোড নথি (ক্লাস রেফারেন্স) — 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.

মিডিয়াউইকি এক্সটেনশন

Introduction to MediaWiki extensions

আপনি যদি মিডিয়াউইকি এক্সটেনশন কোডে কাজ করতে চান, তাহলে নিচের লিঙ্কগুলো আরও তথ্য পেতে পারেন।

মিডিয়াউইকি এক্সটেনশন ব্যাসিক

• Developing extensions — How to write an extension for MediaWiki.
• Extension writing tutorial

মিডিয়াউইকি এক্সটেনশন রিসোর্স

• 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. ফেব্রুয়ারি ২০১১ থেকে।
• Help for extension developers on the Developer Hub

মিডিয়াউইকি আবরণ

Manual:How to make a MediaWiki skin is helpful if you choose to work on MediaWiki skins.

আরও দেখুন

• রিপোজিটরি জুড়ে কোড অনুসন্ধান করুন
• Developer hub – আপনি যদি এই নিবন্ধটি ভালোভাবে অওড়ে থাকেন, তবে ডেভেলপার হাবের তথ্যে যেতে পারেন৷
• আচরণবিধি

Footnotes