การมีส่วนร่วมในเอกสาร MVVMCROSS เป็นวิธีที่มีค่าในการช่วยปรับปรุงกรอบและช่วยเหลือนักพัฒนาอื่น ๆ นี่คือคำแนะนำทีละขั้นตอนเกี่ยวกับวิธีการมีส่วนร่วม:
1. เข้าใจโครงสร้างเอกสาร **
MVVMcross ใช้ Jekyll สำหรับเอกสารซึ่งหมายความว่าแต่ละหน้าต้องใช้เรื่องด้านหน้า YAML ซึ่งรวมถึงการระบุเลย์เอาต์ชื่อเรื่องและหมวดหมู่สำหรับหน้า โดยทั่วไปแล้วเค้าโครงจะถูกตั้งค่าเป็น "เอกสาร" เว้นแต่คุณจะแก้ไขโพสต์บล็อก หมวดหมู่ควรนำกลับมาใช้ใหม่และตั้งชื่ออย่างสม่ำเสมอกับประเภทที่มีอยู่ในเมนู [2]2. ทำความคุ้นเคยกับ Markdown **
เอกสารประกอบใช้ไวยากรณ์ Markdown เดียวกับ GitHub คุณสามารถอ้างถึงการอ้างอิง Markdown ของ GitHub สำหรับแนวทางการจัดรูปแบบ ซึ่งรวมถึงวิธีเพิ่มลิงก์ที่สัมพันธ์กันและรูปภาพไปยังหน้าเอกสารของคุณ [2]3. การตั้งค่า jekyll ในพื้นที่ **
สำหรับการเปลี่ยนแปลงที่มีขนาดใหญ่ขึ้นมันเป็นประโยชน์ในการตั้งค่าไซต์ MVVMCROSS GitHub Pages ในพื้นที่ด้วย Jekyll สิ่งนี้จะช่วยให้คุณดูตัวอย่างการเปลี่ยนแปลงของคุณก่อนที่จะส่ง คุณจะต้องติดตั้ง Jekyll และทำตามคำแนะนำของ GitHub สำหรับการตั้งค่าไซต์ GitHub Pages ในเครื่อง [2]4. แนวทางการบริจาค **
- ชื่อเรื่องและประโยค: ทำให้พวกเขาสั้นและรัดกุม ชื่อควรมีความยาวสามหรือสี่คำ- ลำดับเหตุการณ์: อธิบายหัวข้อในลำดับตรรกะ
- อยู่ในหัวข้อ: หลีกเลี่ยงการหลงทางจากเรื่องหลัก
- ไวยากรณ์และเครื่องหมายวรรคตอน: ตรวจสอบให้แน่ใจว่าการใช้ไวยากรณ์และเครื่องหมายวรรคตอนที่เหมาะสม
- ตัวตรวจสอบการสะกดคำ: ใช้ตัวตรวจสอบการสะกดคำเพื่อลดข้อผิดพลาด [2]
5. ส่งผลงานของคุณ **
โดยทั่วไปแล้วการมีส่วนร่วมจะทำผ่านคำขอดึง GitHub คุณสามารถแก้ไขหน้าเว็บที่มีอยู่หรือสร้างหน้าใหม่ หากคุณไม่แน่ใจเกี่ยวกับวิธีการดำเนินการคุณสามารถเริ่มต้นด้วยการแนะนำการเปลี่ยนแปลงหรือพูดคุยกับทีมผ่านปัญหา GitHub หรือช่องทางสนับสนุนอื่น ๆ [1] [5]6. มีส่วนร่วมกับชุมชน **
นอกเหนือจากการสนับสนุนเอกสารแล้วคุณยังสามารถช่วยด้วยการแบ่งปันประสบการณ์ของคุณกับ MVVMcross การยื่นข้อบกพร่องหรือการมีส่วนร่วมในการอภิปราย ข้อเสนอแนะนี้มีค่าสำหรับการปรับปรุงกรอบงาน [1]7. ทบทวนกระบวนการ **
การมีส่วนร่วมของคุณจะได้รับการตรวจสอบเพื่อให้แน่ใจว่าพวกเขาสอดคล้องกับรูปแบบเอกสารและมาตรฐานคุณภาพ กระบวนการนี้ช่วยรักษาความสอดคล้องในเอกสาร [2]โดยทำตามขั้นตอนเหล่านี้คุณสามารถมีส่วนร่วมในเอกสาร MVVMCROSS ได้อย่างมีประสิทธิภาพและช่วยเพิ่มความเข้าใจและการใช้กรอบของชุมชน
การอ้างอิง:[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-using-app-and-setup
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
[7] https://www.mvvmcross.com/documentation/getting-started/mvvmcross-overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-pomplete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross