วิธีการเป็นแฮกเกอร์มีเดียวิกิ

This page is a translated version of the page How to become a MediaWiki hacker and the translation is 94% complete.
Outdated translations are marked like this.

บทความนี้เขียนขึ้นเพื่อช่วยให้นักพัฒนาได้เรียนรู้ทักษะพื้นฐานที่จำเป็นเพื่อนำไปสู่การพัฒนาแกนมีเดียวิกิ และส่วนขยายมีเดียวิกิ

เส้นทางหลักในการเริ่มต้นใช้งานกับการพัฒนาวิกิมีเดียคือการร่วมกับโครงการวิกิมีเดียที่ให้คำปรึกษา ทางเลือกหนึ่งที่ไม่มีการให้คำปรึกษาคือการแก้ไขบั๊กเล็กน้อยที่น่ารำคาญ

หากคุณเป็นนักพัฒนาที่มีประสบการณ์ที่มีความคุ้นเคยกับการใช้มีเดียวิกิอยู่แล้ว ให้เยี่ยมชมศูนย์กลางนักพัฒนา แทน

สำหรับวิธีการอื่น ๆ ที่จะได้มีส่วนร่วมในชุมชนวิกิมีเดีย ดู วิธีในการมีส่วนร่วม​ในมีเดียวิกิ

ภาพรวม

มีเดียวิกิเป็นซอฟต์แวร์ที่ทรงอานุภาพของวิกิพีเดีย, โครงการพี่น้อง และวิกินับพันทั่วโลก

มีเดียวิกิได้รับการเขียนขึ้นในภาษาโปรแกรมพีเอชพี[1] ใช้เจเควียรีเป็นไลบรารีของจาวาสคริปต์

มีเดียวิกิเขียนขึ้นเป็นหลักสำหรับแลมป์[2] และทำงานในระบบปฏิบัติการส่วนใหญ่ มีเดียวิกิใช้เซิร์ฟเวอร์ฐานข้อมูลมายเอสคิวเอล และมาเรียดีบีเป็นหลัก[3]

การพัฒนาเกิดขึ้นในรูปแบบโอเพนซอร์ส[4] โดยเป็นการประสานงานออนไลน์ส่วนใหญ่ และได้รับการสนับสนุนจากมูลนิธิวิกิมีเดีย แม้ว่าอาสาสมัครพัฒนาชุมชนจะมีส่วนสำคัญเช่นกัน

หน้านี้จะช่วยให้คุณเป็นผู้มีส่วนร่วมกับมีเดียวิกิ นี่ไม่ได้เป็นเกี่ยวกับการสอน มันเป็นเพียงแค่จุดที่คุณไปยังสถานที่ต่าง ๆ ที่คุณสามารถไปเรียนรู้ต่อสิ่งที่จำเป็น

ตั้งค่าสภาพแวดล้อมการพัฒนาของคุณ

โครงการส่วนใหญ่ใช้กิตและเกอร์ริต ทำตามเกี่ยวกับการสอนเกอร์ริต เพื่อตั้งค่าบัญชีนักพัฒนาซอฟต์แวร์ของคุณ จากนั้นคุณสามารถย้ายไปยังการดาวน์โหลดโค้ดของเรา, การทำการเปลี่ยนแปลง, การทดสอบเหล่านั้น และการยื่นเสนอแพตช์ มีสองวิธีการตั้งค่าพัฒนาสิ่งรอบข้างของคุณ: โดยติดตั้งเครื่องเสมือนที่กำหนดไว้ล่วงหน้า (วาแกรนต์ หรือ ดอกเกอร์) หรือวิธีการกำหนดค่าด้วยตนเอง

เครื่องเสมือนกับวาแกรนต์

  • การติดตั้งวาแกรนต์ - ขั้นตอนเหล่านี้จะติดตั้งเซิร์ฟเวอร์มีเดียวิกิ กับความต้องการทั้งหมดภายในเครื่องเสมือนลินุกซ์ (สามารถนำมาใช้บนปฏิคมลินุกซ์, วินโดวส์ หรือแมค)

สภาพแวดล้อมการพัฒนาดอกเกอร์

การติดตั้งด้วยตนเอง

มันไม่จำเป็นต้องดาวน์โหลดฐานข้อมูลวิกิพีเดียกองไว้ เพื่อพัฒนาคุณลักษณะมีเดียวิกิ ในความเป็นจริง ในหลายกรณีก็ง่ายต่อการใช้ฐานข้อมูล ที่อยู่ใกล้กับที่ว่างเปล่ามีเพียงไม่กี่หน้าทดสอบพิเศษที่สร้างขึ้น อย่างไรก็ตาม หากมีเหตุผลบางอย่างที่คุณต้องการที่จะมีสำเนาของวิกิพีเดีย คุณสามารถได้รับการถ่ายโอนข้อมูล

Communication tips and guidelines

ดูในฐานะนักพัฒนาแก้ไขข้อผิดพลาดในส่วนขยายมีเดียวิกิ รวมทั้งการตรวจสอบ, มอบหมายซอฟต์แวร์กิต, ได้รับการตรวจทานและผสาน รวมถึงการปิดตั๋วบั๊กซิลลา (บัดนี้ถูกแทนที่โดย ฟาบริเคเตอร์ )
  • 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.
  • 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.

ภาคผนวก

 
การมีส่วนร่วมมีเดียวิกิที่ทำงานในบังคาลอร์ ประเทศอินเดีย

PHP

มีเดียวิกิได้รับการเขียนในภาษาพีเอชพี ดังนั้นคุณจะต้องได้รับความคุ้นเคยกับภาษาพีเอชพี เพื่อที่จะแฮกแกนของมีเดียวิกิ

เรียนรู้ภาษาพีเอชพี
  • สอนการใช้ภาษาพีเอชพี — ใช้ประโยชน์ได้ในภาษาที่ต่างกัน หากคุณไม่ได้มีความรู้เกี่ยวกับภาษาพีเอชพีแต่รู้วิธีการเขียนโปรแกรมในจุดหมายภาษาโปรแกรมอื่น ๆ ภาษาพีเอชพีก็จะเป็นเรื่องง่ายสำหรับคุณที่จะเรียนรู้
  • PHP Programming at Wikibooks.
  • PHP topic at Wikiversity.
ทรัพยากรภาษาพีเอชพี
สิ่งที่ต้องรู้
  • สคริปต์ maintenance/eval.php ในมีเดียวิกิ ได้เอื้ออำนวยตัวแปลภาษาพีเอชพีพื้นฐาน กับอ็อบเจ็คมีเดียวิกิ และประเภทที่ทำการโหลด
  • นอกจากนี้ สคริปต์ maintenance/shell.php ในมีเดียวิกิเปลี่ยนจาก maintenance/eval.php ที่อิงจากไซเอสเอช (PsySH) ดู Manual:Shell.php

ฐานข้อมูล

คุณสมบัติหลายอย่างจำเป็นต้องมีการจัดการฐานข้อมูลบางส่วน ดังนั้นคุณจึงต้องมีความคุ้นเคยกับมายเอสคิวแอล/มาเรียดีบี

เรียนรู้มายเอสคิวแอล/มาเรียดีบี
ทรัพยากรมายเอสคิวแอล/มาเรียดีบี
สิ่งที่ต้องรู้
  • ทดสอบโค้ดของคุณกับมายเอสคิวแอล/มาเรียดีบี
    • มีเดียวิกิในปัจจุบันใช้มายเอสคิวแอลและมาเรียดีบี เป็นระบบจัดการเว็บไซต์ของฐานข้อมูลหลัก นอกจากนี้ยังสนับสนุนดีบีเอ็มเอสอื่น ๆ เช่น โพสต์เกรสคิวเอล และเอสคิวไลท์ อย่างไรก็ตาม นักพัฒนาเกือบทั้งหมดใช้มายเอสคิวแอล/มาเรียดีบี และไม่ทดสอบดีบีเอ็มเอสอื่น ๆ ซึ่งส่งผลทำลายอยู่เป็นประจำ คุณจึงควรใช้มายเอสคิวแอล/มาเรียดีบีเมื่อทำการทดสอบแพตช์ หากคุณกำลังพยายามที่จะปรับปรุงการสนับสนุนสำหรับฐานข้อมูลอื่นโดยเฉพาะ ในกรณีหลัง ให้แน่ใจว่าคุณระมัดระวังที่จะไม่ทำลายมายเอสคิวแอล/มาเรียดีบี (หรือเขียนคำสั่งที่มีความน่ากลัวที่ไม่มีประสิทธิภาพในนั้น) ตั้งแต่มายเอสคิวแอล/มาเรียดีบีเป็นสิ่งที่คนอื่นใช้

จาวาสคริปต์และซีเอสเอส

จาวาสคริปต์และซีเอสเอส ได้กลายเป็นรหัสส่วนหน้าเว็บไซต์ที่สามารถมองเห็นได้ในบราวเซอร์ที่มีอยู่ทั่วไปทุกหนทุกแห่ง คุณไม่ต้องคุ้นเคยกับจาวาสคริปต์, เจเควียรี และซีเอสเอสในการทำงานกับมีเดียวิกิ แต่คุณอาจต้อง โดยขึ้นอยู่กับสิ่งที่คุณจะเลือกทำงาน

เรียนรู้เกี่ยวกับจาวาสคริปต์และซีเอสเอส
ทรัพยากรจาวาสคริปต์และซีเอสเอส

MediaWiki

ฐานรหัสมีเดียวิกิมีขนาดใหญ่ และมีบางส่วนที่น่าเกลียด ไม่ควรต้องถูกครอบงำโดยสิ่งดังกล่าว เมื่อคุณเริ่มต้นครั้งแรก โดยมุ่งมั่นที่จะเขียนคุณลักษณะหรือแก้ไขบั๊ก ซึ่งโดนเฉพาะอาณาบริเวณขนาดเล็กของรหัสเท่านั้น

ข้อมูลพื้นฐานของมีเดียวิกิและต้องอ่าน
  • สถาปัตยกรรมมีเดียวิกิ — ภาพรวมระดับสูงขององค์ประกอบหลักมีเดียวิกิ และวิธีที่พวกเขาทำงานด้วยกัน
  • Security for developers — ภาพรวมของสาเหตุและวิธีการเขียนโค้ดที่เชื่อถือได้
ทรัพยากรมีเดียวิกิ
  • Manual:Code — รายชื่อของไฟล์ที่สำคัญและเชื่อมโยงไปยังข้อมูลรายละเอียดเพิ่มเติม
  • Manual:Hooks — รายการของตะขอ หากคุณกำลังพยายามที่จะหาสิ่งที่เป็นส่วนหนึ่งของฐานรหัสทำอะไรบางอย่าง ก็มักจะเป็นตำแหน่งที่ดีที่จะเริ่มต้นด้วยการค้นหาตะขอที่เกี่ยวข้อง
  • Manual:Coding conventions — ภาพรวมของการประชุมการเข้ารหัสทั่วไปภายในชุมชนมีเดียวิกิ
  • รหัสเอกสาร (class reference) — สร้างเอกสารจากรหัส และแสดงความคิดเห็นรหัสโดยอัตโนมัติ
  • Manual:How to debug — คู่มือการแก้จุดบกพร่องมีเดียวิกิ
  • Manual:Eval.php — เครื่องมือในการโต้ตอบกับอ็อบเจ็ค ของมีเดียวิกิแบบสด ๆ

ส่วนขยายมีเดียวิกิ

หากคุณเลือกที่จะทำงานในรหัสส่วนขยายมีเดียวิกิ ลิงก์ต่อไปนี้จะให้ข้อมูลเพิ่มเติม

ข้อมูลพื้นฐานเกี่ยวกับส่วนขยายมีเดียวิกิ
ทรัพยากรส่วนขยายมีเดียวิกิ

ดูเพิ่ม

  1. มีเดียวิกิทั้งหมดไม่ได้รับการเขียนขึ้นในภาษาพีเอชพี เครื่องมือสนับสนุนบางอย่างเขียนในภาษาอื่น ๆ รวมไปถึง แบทช์ไฟล์, เชลล์สคริปต์, เมคไฟล์ และภาษาไพทอน
  2. มีเดียวิกิทำงานบนแพลตฟอร์มส่วนใหญ่ที่สามารถรองรับพีเอชพีได้ อย่างไรก็ตาม การขาดคุณสมบัติหรือคุณลักษณะระบบปฏิบัติการบางอย่างอาจจำกัดการทำงานหรือประสิทธิภาพการทำงานของมีเดียวิกิบนแพลตฟอร์มที่ไม่ใช่แลมป์
  3. มีเดียวิกิมีการสนับสนุนฐานข้อมูลนอกเหนือจากมายเอสคิวเอล และมาเรียดีบี รวมไปถึงออราเคิล, โพสต์เกรสคิวเอล, เอสคิวแอลไลท์ และไมโครซอฟท์ เอสคิวแอลเซิร์ฟเวอร์
  4. นักพัฒนาซอฟต์แวร์เป็นกลุ่มอาสาสมัครและพนักงาน (หรือผู้รับเหมา) สำหรับองค์กรต่าง ๆ สำหรับรายชื่อผู้ที่ทำงานกับโค้ดมีเดียวิกิ อ่านบทความ Developers
  5. เรียกดูซอร์สโค้ดและการแก้ไขที่เก็บรหัสที่ https://phabricator.wikimedia.org/diffusion/ หรือดาวน์โหลดซอร์สโค้ดไปยังระบบของคุณโดยใช้เกอร์ริต