wiki

คู่มือการมีส่วนร่วมใน osu! wiki

ขอบคุณที่คุณอยากทำให้ osu! wiki ดีขึ้น บทความนี้จะบอกวิธีการในการมีส่วนร่วมทีละขั้นตอน ในกรณีที่คุณมีความคุ้ยเคยกับ GitHub คุณสามารถทำตาม feature-branch workflow เพื่อสร้างการเปลี่ยนแปลงใด ๆ และข้ามไปที่หัวข้อ ตรวจสอบงานของตัวเอง ได้เลย

ผู้มีส่วนร่วมรายใหม่ที่ยังไม่คุ้นเคยใน GitHub หรือ git เนื่องจากนี่เป็นเครื่องมือที่มักจะใช้งานในกลุ่มนักพัฒนาเป็นหลัก หากคุณยังไม่เข้าใจในการลองครั้งแรก ไม่ต้องกังวลไป — wiki maintainer จะช่วยเหลือ และพาคุณไปในทิศทางที่ถูกต้อง

ในกรณีที่คุณต้องการความช่วยเหลือ หรือคำแนะนำในขั้นตอนไหนก็ตาม อย่าลังเลที่จะถามเข้ามาในช่อง #osu-wiki ของ osu!dev Discord server.

ขอบเขตของงาน

ถ้าคุณอยากจะช่วย แต่ไม่แน่ใจว่าจะเริ่มต้นอย่างไร ลองดู osu! wiki maintenance § Routines เพื่อค้นหารายการของงานที่ต้องการให้ทำโดยทั่วไป และวิธีการในการช่วยเหลือเหล่าผู้มีส่วนร่วมคนอื่น ๆ ในการทำให้ตัวคุณคุ้นเคยกับรูปแบบภาษาที่ใช้ใน wiki ลองดู Markdown Cheatsheet ของ Adam Pritchard

การแก้ไข wiki

สำหรับกระบวนการการมีส่วนร่วมทั่วไป ลองตรวจสอบ GitHub flow - GitHub Docs

บทความของ osu! wiki ถูกบันทึกอยู่ใน GitHub หากต้องการช่วยเหลือ ทำตามขั้นตอนเหล่านี้

  1. สร้าง บัญชี GitHub
  2. เปิด ppy/osu-wiki และเลือก Fork จากมุมขวาบน เพื่อให้สามารถควบคุม wiki ฉบับคัดลอก คุณสามารถเลือกไปที่ fork ของตัวเองได้โดยการไปที่ ppy/osu-wiki และเลือก Fork อีกครั้ง
  • ถ้าคุณได้สร้าง fork เมื่อนานมาแล้ว สามารถซิงค์ได้โดยวิธีการนี้ Best practices § Syncing the fork
  1. อ่าน Best practices § Making changes และเริ่มดำเนินการที่จำเป็นได้เลยโดยคุณมีอิสระในการเลือกแอปพลิเคชั่นในการทำ อย่างไรก็ตาม osu! wiki มีคำแนะนำโดยละเอียดสำหรับการใช้ 2 อย่างนี้
  • GitHub web-based editor (ออนไลน์, ไม่มีการติดตั้งเพิ่มเติม).
  • GitHub Desktop (ออฟไลน์, สามารถจัดการอะไรได้มากกว่า).

ตรวจสอบงานของตัวเอง

เมื่อคุณได้สร้างการเปลี่ยนแปลงใด ๆ เรียบร้อยแล้ว โปรดใช้เวลาในการอ่านทบทวนงานของคุณ โดยตรวจสอบตามขั้นตอนเหล่านี้

  • น้ำเสียงของบทความ: บทความของ osu! wiki จะต้องถูกเขียนโดยการใช้ความเป็นกลาง โดยมีข้อยกเว้นเล็กน้อยในบางกรณี
  • สไตล์ และไวยากรณ์: บทความต่าง ๆ ต้องมีความชัดเจน เข้าใจง่าย ไม่ส่งผลกระทบต่อจิตใจผู้อ่าน เนื้อหามีความสอดคล้อง และหลีกเลี่ยงประโยคที่มีความซับซ้อน คุณสามารถใช้ตัวช่วยเขียนที่มีตัวตรวจคำผิดอย่าง Google Docs เผื่อแก้ไขคำผิด ไวยากรณ์ และการใช้ syntax ต่าง ๆ
  • Content parity บทแปลจะต้องมีเนื้อหาเดิมกับบทความต้นฉบับ (การเปลี่ยนแปลงทางด้านการเว้นวรรค การใช้คำ หรือการจัดรูปแบบ เป็นสิ่งที่เกิดขึ้นได้) แทนที่จะเปลี่ยนเนื้อหาบทความต้นฉบับให้ลอง open an issue หรือเปิด pull request อันใหม่ที่แก้ไขบทความต้นฉบับ ถ้าคุณรู้สึกว่ามันยังไม่สมบูรณ์ ไม่ถูกต้อง หรือเก่าเกินไป
  • โครงสร้าง และการจัดรูปแบบ ลองดูตัวอย่างงานของคุณผ่านเครื่องมืออย่าง jbt's Markdown Editor เพื่อทำให้แน่ใจว่างานของคุณมีหน้าตาเหมือนกับที่คุณคิดไว้
  • รูปภาพทุกรูป และไฟล์อื่น ๆ ที่ไม่ใช้ตัวหนังสือ จะต้อง เล็กกว่า 1 megabyte ภาพหน้าจอ จะต้องใช้สกินเริ่มต้นของ osu! และใช้ การตั้งค่าที่กำหนด โดยมีขนาดไม่เกิน 1280×720

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

Pull request

หลังจากตรวจทานการเปลี่ยนแปลงต่าง ๆ, commit และ push ไปยัง fork ของคุณแล้ว คุณต้องเสนอมันไปยังผู้ดูแลโดยการเปิด pull request

  1. ใน Fork ของคุณ ของ osu! wiki หา droupdown ที่เขียนว่า master↓ และเลือก branch ที่มีการเปลี่ยนแปลงของคุณ
  2. เลือกปุ่ม Contribute↓ และเลือก Open pull request
  3. เติมรายละเอียดตาม Best practices § Opening a pull request และเลือก Create pull request

การ Review

การเปลี่ยนแปลงทุกอย่างใน osu! wiki จะได้รับการกลั่นกรอง ในระหว่างขั้นตอนการตรวจสอบ จะมีผู้ประสานงานชี้จุดที่ผิดพลาด และวิธีการในการแก้ไขในรูปแบบ free form หรือบอกตรง ๆ ใน pull request เช่นเดียวกับการตรวจสอบแบบอื่น ๆ คุณต้องมีการเขียนความคิดเห็นเพิ่มเติมโดยการ ตั้งข้อเสนอแนะ หรืออธิบายเพิ่มเติมว่าทำไมถึงอยากจะให้จุดเหล่านั้นเป็นไปตามที่คุณแก้ไข

ถ้าผ่านไปหลายวันแล้วไม่มีใครมาตรวจสอบ ลองทำตามขั้นตอนเหล่านี้

  • ตรวจให้แน่ใจว่าคุณได้แก้ไขตามคำแนะนำทั้งหมดแล้ว บางทีผู้ตรวจสอบอาจรอคำตอบของคุณอยู่
  • ลองถามผู้เขียน osu! wiki คนอื่น ๆ ใน osu!dev Discord server (ช่อง #osu-wiki ) หรือใน GitHub comment
  • ในการขอความช่วยเหลือด้านการแปล ตรวจสอบ pull request ที่ merged เรียบร้อยแล้วของภาษาของคุณ ลองเข้าไปติดต่อผู้ตรวจสอบ หรือผู้เขียนของ pull request อันนั้น (example GitHub query)
  • ลองให้เพื่อนมาดูแบบเร็ว ๆ

เพิ่มเติมเกี่ยวกับขั้นตอนการตรวจสอบ osu! wiki repository มี การตรวจสอบโดยอัตโนมัติ ที่จะทำให้แน่ใจว่าการเปลี่ยนแปลงของคุณเป็นไปตามรูปแบบของ wiki และไม่มีการจัดรูปแบบที่ผิดพลาด คุณสามารถตรวจสอบสถานะได้โดยการเปิดแถบ Actions ใน pull request ของคุณ หากเจอ error ลองทำตามข้อความวินิจฉัยข้อผิดพลาด ด้านล้างของข้อความ error

การ Merge

การเปลี่ยนแปลงของคุณจะได้รับการตรวจสอบโดยหนึ่งใน ผู้ดูแล โดยปกติหลังจากได้รับการตรวจสอบจากผู้ประสานงานแล้ว ถ้าไม่มีอะไรเกิดขั้นหลังจากเวลาผ่านไประดับหนึ่ง ลองถามใน GitHub comment ของ pull request หรือในช่อง #osu-wiki ของ osu!dev Discord server การเปลี่ยนแปลงของคุณจะปรากฏใน osu! wiki ไม่นานหลังจาก merge (อาจใช้เวลาถึง 5 ชั่วโมงในบางกรณี)