MediaWiki hackeri olma
Bu madde, geliştiricilerin MediaWiki çekirdeği ve MediaWiki uzantılarının geliştirilmesine katkıda bulunmak için gereken temel becerileri öğrenmelerine yardımcı olmak için yazılmıştır. Çoğu durumda MediaWiki ile çalışırken, ne yaptığınızı gerçekten bilmiyorsanız MediaWiki çekirdeğini hack yapmak istemezsiniz.
MediaWiki'yi zaten tanıdık deneyimli bir geliştiriciyseniz, onun yerine Geliştirici merkezi sayfasını ziyaret edin.
Wikimedia topluluğuna katılmanın diğer yolları için Nasıl katkıda bulunur sayfasına bakın.
Genel bakış
MediaWiki, Vikipedi'nin, onun kardeş projelerinin ve binlerce vikinin tüm dünyada güç sağlayan bir yazılımdır.
- Geliştirme tartışması çeşitli posta gönderme listeleri ve IRC kanallarında MediaWiki üzerinde gerçekleşir. Ana geliştirici listesi wikitech-l. Ana geliştirici IRC kanalları bağlan ve bağlan şeklindedir.
- Kaynak kodu, Git revizyon kontrol sistemi https://phabricator.wikimedia.org/diffusion/ veya Gerrit'i kullanarak kaynak kodu sisteminize indirin.</ref>
- Kod incelemesi Gerrit üzerinde yapılır. Yamaları göndermek üzere Git ve Gerrit'i ayarlamak için bu eğitimi izleyin.
- Hata raporları ve görevler Phabricator üzerinde yönetilir.
Bu sayfa MediaWiki'ye katkıda bulunmanıza yardımcı olmalıdır. Öğretici değildir; gerekli olanı öğrenmek için gidebileceğiniz çeşitli yerlere işaret ediyor.
Geliştirme ortamınızı kurun
Çoğu proje Git ve Gerrit kullanır. Geliştirici hesabınızı oluşturmak için Gerrit eğitimini uygulayın. Ardından, kodumuzu indirmek, değişiklik yapmak, test etmek ve yamalar göndermek için devam edebilirsiniz. Geliştirme ortamınızı ayarlamanın iki yolu vardır: önceden yapılandırılmış bir sanal makine kurulumu (Vagrant veya Docker) veya manüel yapılandırma yaklaşımı kullanma.
Vagrant ile Sanal Makine
- Vagrant kurulumu — Bu adımlar MediaWiki sunucusunu bir Linux sanal makinesi içerisindeki tüm gereksinimlerle birlikte yükleyecektir (Linux, Windows veya Mac bilgisayarlarda kullanılabilir).
Docker geliştirme ortamı
- MediaWiki Docker – MediaWiki'yi Docker kullanarak çalıştırın (Linux, Windows veya macOS ana bilgisayarlarında kullanılabilir).
Manüel kurulum
- Kurulum gereksinimleri — Donanım gereksinimlerini kontrol edin ve bir LAMP, MAMP veya WAMP sunucusu (Linux, Mac veya Windows, ayrıca Apache, MySQL/MariaDB ve PHP) yükleyin.
- Git'ten yükle — En son kaynak kodunu Git'ten indirin.
- Kurulum kılavuzu — Yükleme ve başlangıç yapılandırmasına devam edin.
- Uyarı ve hataları erkenden görüntülemek için ortamınızdaki çeşitli hata ayıklama modlarını ayarlayın.
MediaWiki özelliklerini geliştirmek için Vikipedi veritabanı dökümlerini indirmek gerekli değildir. Aslında, çoğu durumda, birkaç özel hazırlanmış sınama sayfası bulunan boş boş bir veritabanını kullanmak daha kolaydır. Bununla birlikte, eğer bir nedenle Vikipedi'nin bir kopyasını almak istiyorsan, bir dökümü alabilirsiniz.
İletişim ipuçları ve yönergeler
- 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 Phabricator 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.
İlave
PHP
MediaWiki PHP ile yazılmıştır, bu nedenle MediaWiki'nin çekirdeğini kesmek için PHP'ye aşina olmanız gerekir.
- PHP öğrenin
-
- PHP kaynakları
-
- Bilmeniz gereken şeyler
-
- MediaWiki'deki
maintenance/eval.phpbetiği, MediaWiki nesneleri ve sınıfları yüklenen basit bir PHP yorumlayıcı sağlar.
- Ayrıca, MediaWiki'deki
maintenance/shell.phpbetiği, PsySH tabanlı
maintenance/eval.phpyerine geçer, Manual:Shell.php sayfasına bakın.
- MediaWiki'deki
Veritabanı
Birçok özellik, bir miktar veritabanı manipülasyonu gerektirir, bu nedenle sıklıkla MySQL/MariaDB'yi tanımanız gerekir.
- MySQL/MariaDB kaynakları
-
- Bilmeniz gereken şeyler
-
- Kodunuzu MySQL/MariaDB ile test edin.
- MediaWiki şu anda birincil veritabanı arka uç olarak MySQL ve MariaDB'yi kullanmaktadır. Ayrıca PostgreSQL ve SQLite gibi diğer DBMS'leri de destekler. Bununla birlikte, hemen hemen tüm geliştiriciler MySQL/MariaDB'yi kullanır ve sonuç olarak düzenli olarak kesilen diğer DB'leri test etmezler. Bu nedenle, özellikle başka bir DB için desteği geliştirmeye çalışmadıkça yamaları test ederken MySQL/MariaDB'yi kullanmanız önerilir. İkinci durumda, MySQL/MariaDB'yi kırmamaya özen gösterin (veya içinde korkunç derecede yetersiz olan soruları yazın), çünkü MySQL/ MariaDB herkesin kullandığı şeydir.
- Kodunuzu MySQL/MariaDB ile test edin.
JavaScript ve CSS
JavaScript ve CSS, ön uç kodunda her zaman mevcut hale geldi. MediaWiki'de çalışmak için JavaScript, jQuery ve CSS hakkında bilgi sahibi olmak zorunda değilsiniz, ancak ne üzerinde çalışmayı seçtiğinize bağlı olarak yapmanız gerekebilir.
- JavaScript ve CSS'yi öğrenin
-
- JavaScript ve CSS kaynakları
-
MediaWiki
MediaWiki kod tabanı büyük ve bazı bölümleri çirkin; onun tarafından kaplamayın. İlk başladığınızda, yalnızca küçük bir kod bölgesine dokunan özellikler yazmayı veya hataları düzeltmeyi hedefleyin.
- MediaWiki ile ilgili temel bilgiler ve okunması gereken bilgiler
-
- MediaWiki kaynakları
-
- Manual:Code — Önemli dosyaların bir listesi ve daha ayrıntılı bilgilere bağlantılar.
- Manual:Hooks — Kanca listesi. Kod tabanının bir kısmının bir şey yaptığını bulmaya çalışıyorsanız, genellikle başlamak için iyi bir yer ilgili kancaları aramaktır.
- Manual:Coding conventions — MediaWiki topluluğunda genel kodlama sözleşmelerine genel bir bakış.
- Kod belgelemesi (sınıf kaynağı) — Kod ve kod yorumlarını otomatik olarak oluşturulan belgeler.
- Manual:How to debug — MediaWiki'nin hata ayıklanması için bir kılavuz.
- Manual:Eval.php — MediaWiki nesneleri ile etkileşim kurmak için bir araç yaşıyor.
MediaWiki uzantıları
MediaWiki uzantıları koduyla çalışmayı seçerseniz, aşağıdaki bağlantılar daha fazla bilgi sağlar.
- MediaWiki uzantılarına ilişkin temel bilgiler
-
- MediaWiki uzantıları kaynakları
-
- Uzantılar için en iyi uygulamalar
- MediaWiki uzantısı geliştirmeye kısa bir giriş — MediaWiki uzantısının nasıl oluşturulacağı hakkında bir video sunumu (slaytlar).
- MediaWiki uzantısı oluşturma — MediaWiki için bir eklentinin nasıl geliştirileceğini, en iyi uygulamaları ve MediaWiki topluluğunun nasıl dahil edileceğini kapsar. Şubat 2011'den itibaren.
- Geliştirici Merkezi'ndeki uzantı geliştiricileri için yardım
Ayrıca bakınız
- Depolarda kod arayın
- Geliştirici merkezi – Bu maddede ki bilgileri tamamen okuduğunuzda, geliştirici merkezinde ki bilgilere geçme zamanı gelmiştir.
- Davranış Kodu
- MediaWiki'nin tamamı PHP ile yazılmamıştır. Bazı destek araçları toplu iş dosyaları, kabuk betiği, makefile ve Python diğer dillerde yazılmıştır.
- MediaWiki, PHP'yi destekleyen çoğu platformda çalışır, ancak, bazı yardımcı programların veya işletim sistemi özelliklerinin eksikliği, işlevselliklerini veya performanslarını sınırlayabilir. LAMP dışı platformlarda MediaWiki.
- MediaWiki MySQL ve MariaDB dışındaki Veritabanı desteği var, PostgreSQL, SQLite dahil.
- Geliştiriciler, çeşitli kuruluşlar için gönüllülerin ve ücretli personelin (veya müteahhitlerin) bir karışımıdır. MediaWiki kodunda çalışanların tam listesi için, Geliştiriciler makalesini okuyun.