เมื่อจัดรูปแบบปัญหา GitHub สำหรับ MVVMCROSS การปฏิบัติตามแนวทางปฏิบัติที่ดีที่สุดสามารถเพิ่มความชัดเจนประสิทธิภาพและการทำงานร่วมกัน นี่คือแนวทางโดยละเอียดบางประการ:
1. ชื่อเชิงพรรณนา **
ใช้อารมณ์ที่จำเป็นและตรวจสอบให้แน่ใจว่าชื่อมีความหมายเพียงพอที่จะถ่ายทอดวัตถุประสงค์ของปัญหา หลีกเลี่ยงการสิ้นสุดชื่อเรื่องด้วยช่วงเวลา ตัวอย่างเช่น "แก้ไขข้อผิดพลาดในการเชื่อมโยงข้อมูล" มีประสิทธิภาพมากกว่า "บั๊กในการเชื่อมโยงข้อมูล" หรือ "ข้อบกพร่องการเชื่อมโยงข้อมูล" [4] [7]2. ล้างภาพรวม **
ให้ภาพรวมที่กระชับของปัญหาในสองบรรทัดหรือน้อยกว่า ซึ่งควรรวมถึงวัตถุประสงค์หลักหรือปัญหาที่ได้รับการแก้ไข ตัวอย่างเช่น "ปัญหานี้มีจุดมุ่งหมายเพื่อแก้ไขข้อผิดพลาดที่มีผลผูกพันข้อมูลทำให้แอปล่มบนอุปกรณ์ Android" [1] [4]3. การพึ่งพา (ถ้ามี) **
หากปัญหาขึ้นอยู่กับปัญหาอื่นที่ได้รับการแก้ไขก่อนให้เชื่อมโยงไปยังปัญหานั้น สิ่งนี้จะช่วยรักษาเวิร์กโฟลว์ที่ชัดเจนและทำให้มั่นใจได้ว่างานที่ต้องพึ่งพาจะได้รับการแก้ไขตามลำดับที่ถูกต้อง ตัวอย่างเช่น "ปัญหานี้ขึ้นอยู่กับ [ลิงก์ไปยังปัญหาขึ้นอยู่กับ]" [1]4. รายการการดำเนินการ **
รูปแบบรายการการดำเนินการเป็นรายการตรวจสอบแบบคลิกได้ สิ่งนี้ทำให้ง่ายต่อการติดตามความคืบหน้าและมอบหมายงานให้กับสมาชิกในทีม ตัวอย่างเช่น:- [] ค้นคว้าสาเหตุของข้อผิดพลาดที่มีผลผูกพันข้อมูล
- [] ใช้การแก้ไขสำหรับปัญหาที่ระบุ
- [] ทดสอบการแก้ไขบนหลายแพลตฟอร์ม [1] [4]
5. ทรัพยากร/คำแนะนำ **
รวมลิงก์ไปยังเอกสารหรือทรัพยากรที่เกี่ยวข้องที่สามารถช่วยในการแก้ไขปัญหา ซึ่งอาจรวมถึงบทเรียนเอกสาร API หรือการอภิปรายก่อนหน้านี้ที่เกี่ยวข้องกับปัญหา ตัวอย่างเช่น "อ้างถึง [MVVMCROSS Documentation] (https://mvvmcross.com/docs) สำหรับคำแนะนำเกี่ยวกับการเชื่อมโยงข้อมูล" [1] [2]6. ผู้ได้รับมอบหมาย **
กำหนดปัญหาให้กับสมาชิกในทีมที่เฉพาะเจาะจง สิ่งนี้ทำให้มั่นใจได้ถึงความรับผิดชอบและความชัดเจนว่าใครเป็นผู้รับผิดชอบงาน ใช้คุณสมบัติ "ผู้ได้รับมอบหมาย" ใน GitHub เพื่อกำหนดผู้ใช้ [1]7. ป้ายกำกับ **
ใช้ป้ายกำกับที่เกี่ยวข้องเพื่อจัดหมวดหมู่ปัญหา สิ่งนี้ช่วยในการกรองและจัดลำดับความสำคัญปัญหาภายในโครงการ ตัวอย่างเช่นฉลากอาจรวมถึง "บั๊ก" "คุณลักษณะ" หรือ "การปรับปรุง" [1] [2]8. บอร์ดโครงการ **
ตรวจสอบให้แน่ใจว่ามีการเพิ่มปัญหาลงในบอร์ดโครงการและทำการทดลองอย่างเหมาะสม สิ่งนี้เกี่ยวข้องกับการตั้งค่าสถานะปัญหาเป็น "กล่องน้ำแข็ง" หากยังไม่พร้อม "จัดลำดับความสำคัญ backlog" ถ้ามันพร้อม แต่ไม่ได้ออกแบบและ "กำลังดำเนินการ" เมื่อได้รับมอบหมาย [1]9. เหตุการณ์สำคัญ **
ใช้เหตุการณ์สำคัญเพื่อติดตามความคืบหน้าของกลุ่มปัญหาหรือดึงคำขอ สิ่งนี้มีประโยชน์อย่างยิ่งสำหรับโครงการขนาดใหญ่หรือเมื่อติดตามงานที่เกี่ยวข้องหลายอย่าง [1]10. การอัปเดตเอกสารและความคืบหน้า **
อัปเดตปัญหาความคิดเห็นที่มีความคืบหน้าหรือการเปลี่ยนแปลงเป็นประจำ สิ่งนี้ทำให้ผู้มีส่วนได้ส่วนเสียทั้งหมดได้รับการแจ้งและอำนวยความสะดวกในการแก้ปัญหาการทำงานร่วมกัน [7]ตัวอย่างของปัญหาที่ได้รับการจัดรูปแบบที่ดี
** ชื่อเรื่อง: แก้ไขข้อผิดพลาดการเชื่อมโยงข้อมูลบนอุปกรณ์ Android
** ภาพรวม: ปัญหานี้ระบุข้อผิดพลาดที่มีผลผูกพันข้อมูลทำให้แอปล่มบนอุปกรณ์ Android
** การพึ่งพา: ขึ้นอยู่กับ [ลิงก์ไปยังปัญหาขึ้นอยู่กับ]
รายการการดำเนินการ:
- [] ตรวจสอบสาเหตุของข้อผิดพลาดที่มีผลผูกพันข้อมูล
- [] ใช้การแก้ไขตามการค้นพบ
- [] ดำเนินการทดสอบอย่างละเอียดข้ามแพลตฟอร์ม
** ทรัพยากร/คำแนะนำ: อ้างถึง [MVVMCROSS Documentation] (https://mvvmcross.com/docs) สำหรับคำแนะนำการเชื่อมโยงข้อมูล
** ผู้ได้รับมอบหมาย: @username
** ป้ายกำกับ: Bug, Android
โดยทำตามแนวทางเหล่านี้คุณสามารถสร้างปัญหา GitHub ที่มีโครงสร้างที่ดีขึ้นซึ่งช่วยเพิ่มความร่วมมือและประสิทธิภาพภายในโครงการ MVVMcross
การอ้างอิง:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-table
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross-samples
[6] https://github.com/mvvmcross/mvvmcross-samples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-practices-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md