การเพิ่มประสิทธิภาพการทำงานกับโปรเจ็กต์ของคุณบน GitHub: ทำความคุ้นเคยกับ Github Template Repository

สวัสดีทุกคน ชุมชน JavaRush! วันนี้เราจะพูดถึงโอเพ่นซอร์สและสิ่งที่จำเป็นในการสร้างโปรเจ็กต์คุณภาพสูงนอกเหนือจากโค้ดที่เขียน การเขียนผลิตภัณฑ์ที่มีประโยชน์เป็นสิ่งสำคัญ แต่สิ่งสำคัญไม่น้อยไปกว่าคือการออกแบบพื้นที่เก็บข้อมูลที่ถูกต้อง (พื้นที่เก็บข้อมูลโครงการบน GitHub) สิ่งนี้จะช่วยในการดำเนินการตามประเด็นสำคัญอีกประการหนึ่งนั่นคือการส่งเสริมผลิตภัณฑ์ แม้ว่าโครงการจะเจ๋งสุด ๆ แต่ถ้าได้รับการออกแบบมาไม่ดี อย่างน้อยก็ไม่ได้อธิบายไว้ใน README (คุณสามารถอ่านเกี่ยวกับสิ่งที่ README ได้ที่นี่ ) ไม่ได้ระบุใบอนุญาต ฯลฯ ก็จะไม่ประสบความสำเร็จ เพียงแต่จะไม่มีใครสังเกตเห็นเขา และถ้าใครสังเกตเห็นก็จะไม่รู้ว่าจะโต้ตอบกับเขาอย่างไร มีหลายสิ่งที่ต้องกรอกซ้ำแล้วซ้ำเล่า และไม่ใช่เรื่องง่ายสำหรับโปรแกรมเมอร์ที่จะคัดลอกและวางในแต่ละครั้ง และสำหรับฤดูร้อนนี้ GitHub ได้เปิดตัวฟีเจอร์Template Repositoryที่ช่วยในเรื่องนี้ พูดง่ายๆ ก็คือทำให้กระบวนการสร้างโปรเจ็กต์ใหม่เป็นไปโดยอัตโนมัติ วันนี้เราจะมาทำความเข้าใจว่า Repository คืออะไร และ Template Repository คืออะไร เราจะอธิบายสิ่งที่ควรอยู่ในโปรเจ็กต์นอกเหนือจากโค้ด สิ่งที่คุณต้องให้ความสำคัญ มาสร้าง Template Repository ตั้งแต่เริ่มต้นและเพิ่มทุกสิ่งที่จำเป็นจากมุมมองของฉัน และสุดท้าย เราจะใช้ Template Repository เมื่อสร้าง repository ใหม่ แต่ก่อนอื่นเรามาทำความเข้าใจเงื่อนไขกันก่อน ทฤษฎี: สิ่งที่ควรอยู่ในพื้นที่เก็บข้อมูลทั่วไปของโครงการใดๆทุกโครงการโอเพ่นซอร์สบน GitHub ควรมีโปรไฟล์ชุมชน ที่อธิบายไว้อย่างดี ซึ่งประกอบด้วยองค์ประกอบต่อไปนี้

1. เทมเพลตฉบับ

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

• รายงานข้อผิดพลาด - สร้างปัญหาเพื่ออธิบายข้อบกพร่องในโครงการ
• คำขอคุณลักษณะ - ข้อเสนอแนวคิดใหม่สำหรับโครงการ
• คำขอปรับปรุง - ข้อเสนอเพื่อปรับปรุงโครงการ
• เทมเพลตปัญหาที่กำหนดเอง - หากตัวเลือกอื่นใช้ไม่ได้ผล คุณสามารถใช้เทมเพลตเปล่าได้

ตัวอย่างของลักษณะนี้สามารถดูได้ที่ นี่

2. ใบอนุญาต

ใบอนุญาตที่เขียนโครงการ มีความจำเป็นเพื่อให้ผู้ที่จะใช้โครงการรู้ว่าสิ่งใดรับประกันและสิ่งใดไม่รับประกัน ตัวอย่างเช่นApache License 2.0ระบุข้อความต่อไปนี้:

3.อ่านให้ฉันฟัง

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

• ภาพรวม - คำอธิบายโดยย่อของโครงการ
• การใช้งาน - วิธีการใช้งานโครงการ
• การสร้าง - วิธีเปิดตัวโครงการสิ่งที่จำเป็นสำหรับสิ่งนี้
• การแก้ไขปัญหา - อธิบายถึงปัญหาที่คุณอาจพบและวิธีแก้ปัญหา
• บันทึกประจำรุ่น - คำอธิบายการเปลี่ยนแปลงขึ้นอยู่กับเวอร์ชัน
• ผู้เขียน - อย่าลืมคนที่คุณรัก
• การมีส่วนร่วม - คำอธิบายว่าคุณสามารถมีส่วนร่วมในการพัฒนาโครงการได้อย่างไร
• หลักจรรยาบรรณ - คำอธิบายกฎการเข้าร่วม
• RELEASE_NOTES - ไฟล์ที่บันทึกการเปลี่ยนแปลงทั้งหมดสำหรับเวอร์ชันใหม่ แนวทางปฏิบัติที่ดีในการเก็บสิ่งนี้ไว้ในเอกสารแยกต่างหากและจัดเก็บลิงก์ไว้ใน README
• CONTRIBUTINGเป็นไฟล์ที่อธิบายว่าคุณสามารถมีส่วนร่วมในการพัฒนาโครงการนี้ได้อย่างไร สร้างเป็นไฟล์แยกต่างหากสำหรับส่วนหัวที่สนับสนุนใน README
• CODE_OF_CONDUCT - ไฟล์ที่อธิบายกฎสำหรับการเข้าร่วมในการพัฒนาโครงการ
• เทมเพลตคำขอดึง - เทมเพลตสำหรับผู้ที่จะสร้างคำขอดึง

สิ่งเหล่านี้ทั้งหมดถูกนำมาใช้จากโครงการหนึ่งไปอีกโครงการหนึ่ง โดยไม่คำนึงถึงภาษาการเขียนโปรแกรมหรือข้อมูลเฉพาะของมัน

แนวปฏิบัติ: สร้างเทมเพลตของคุณเอง

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

1. สิ่งแรกที่คุณต้องมีคือบัญชีใน GitHub / ลงทะเบียนที่นั่น .

2. สร้างที่เก็บใหม่: โดยคลิก + ที่มุมขวาบน

3. เมื่อสร้าง ให้กรอก:

   • ชื่อพื้นที่เก็บข้อมูล - ในกรณีของฉัน repository-template;
   • Description — คำอธิบายโดยย่อของโครงการ
   • เราปล่อยให้สาธารณะแม้ว่าคุณจะสามารถเลือกส่วนตัวได้
   • ทำเครื่องหมายในช่องการเริ่มต้น README:

   • เลือกใบอนุญาตที่โครงการจะเป็น:

     เนื่องจากในกรณีของฉัน เทมเพลตเป็นแบบทั่วไป จึงไม่จำเป็นต้องใช้ gitignore เพราะจะถูกเพิ่มสำหรับโปรเจ็กต์และภาษาการเขียนโปรแกรมเฉพาะ

     ดังนั้นให้คลิกCreate Repositoryเพื่อเสร็จสิ้นกระบวนการสร้าง ระบบจะนำเราไปยังพื้นที่เก็บข้อมูลที่สร้างขึ้นใหม่โดยอัตโนมัติ

4. กรอกโปรไฟล์ชุมชน : ในพื้นที่เก็บข้อมูลที่สร้างขึ้น ไปที่ แท็บ ข้อมูลเชิงลึกและเลือกชุมชน :

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

   เมื่อใช้ตัวอย่างหลักจรรยาบรรณ เราจะแสดงวิธีเพิ่มลงในโครงการ

   คลิกเพิ่มระบบจะแจ้งให้คุณเลือกContributor CovenantหรือCitizen Code of Conduct :

   ฉันเลือกอันแรกแล้วคลิกตรวจสอบและส่ง

   ถัดไป คุณสามารถแก้ไขไฟล์นี้และคอมมิตมันได้

   ที่ด้านล่าง เลือก ตัว เลือก Commit direct to the master Branchแล้วคลิกCommit new file :

   ด้วยเหตุนี้ หากเรากลับไปที่โปรไฟล์ชุมชนเราจะพบว่าหลักปฏิบัติถูกทำเครื่องหมายว่าเพิ่มไว้:

   เทมเพลตการบริจาคและเทมเพลตปัญหาถูกเพิ่มในลักษณะเดียวกัน ดังนั้นฉันจะไม่แสดงสิ่งนี้ ทำด้วยตัวคุณเอง ;)

5. เพิ่ม เทมเพลต คำขอดึง

   แต่เราจะพูดถึงเรื่องนี้แยกกัน

   ฉันไม่รู้ว่าทำไม GitHub จึงไม่เพิ่มตัวเลือกที่สะดวกสบายแบบเดียวกันในการตั้งค่าเทมเพลต Pull-Request ดังนั้นคุณจะต้องศึกษาเอกสารประกอบ และเพิ่มด้วยตนเอง

   เมื่อต้องการทำเช่นนี้ คลิกสร้างไฟล์ใหม่ ในรากของที่เก็บ :

   ชื่อไฟล์ควรเป็น: .github /pull_request_template.md

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

   ด้วยวิธีนี้โปรไฟล์ชุมชนทั้งหมดจะถูกกรอก:

6. เพิ่ม เครื่องหมายที่ เก็บเทมเพลต

   ในการดำเนินการนี้ ให้ไปที่ ตัวเลือก การตั้งค่าในพื้นที่เก็บข้อมูล และทำเครื่องหมายในช่องที่ระบุว่าที่เก็บเทมเพลต:

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

วิธีใช้ที่เก็บเทมเพลต

มีสองตัวเลือกสำหรับการใช้งาน:

1. เมื่อเทมเพลตเป็นของคุณโดยตรง:เมื่อสร้างพื้นที่เก็บข้อมูลใหม่ คุณจะได้รับตัวเลือกให้สร้างจากเทมเพลตจากรายการเทมเพลตที่คุณเป็นเจ้าของ:

2. เมื่อเทมเพลตเป็นแบบต่างประเทศ:ก็ไม่มีปัญหาพิเศษเช่นกัน ไปที่เทมเพลตนั้นแล้วคลิก ปุ่ม ใช้เทมเพลตนี้ ที่นี่ฉันจะใช้ภาพเคลื่อนไหวจากเอกสารอย่างเป็นทางการ:

มาสรุปกัน

ในบทความนี้เราดูที่:

• พื้นที่เก็บข้อมูล GitHub คืออะไร
• พื้นที่เก็บข้อมูลเทมเพลตคืออะไร
• สิ่งที่ควรอยู่ในที่เก็บเทมเพลต
• วิธีสร้างที่เก็บเทมเพลต
• วิธีใช้ที่เก็บเทมเพลต

แน่นอนว่าตามเทมเพลตนี้ คุณสามารถสร้างเทมเพลตที่เจาะจงมากขึ้นได้แล้ว ตัวอย่างเช่น ฉันสร้างเทมเพลตเพิ่มเติมโดยมี ระบบ mavenหรือgradle build ที่กำหนดค่าไว้แล้ว เพิ่มเติม: คุณสามารถสร้าง Spring Boot Repository Template ตามสองอันสุดท้ายได้ ในการจัดกลุ่มเทมเพลตทั้งหมด ฉันได้สร้าง องค์กร ที่เก็บเทมเพลตบน GitHub พร้อมด้วยเทมเพลตทั้งหมด สมัครสมาชิกบัญชี GitHub ของฉัน

ลิงค์ที่เป็นประโยชน์

• จัดระเบียบด้วยเทมเพลตทั้งหมดที่ฉันสร้างขึ้น
• บล็อก GitHub: สร้างพื้นที่เก็บข้อมูลใหม่ด้วยเทมเพลตพื้นที่เก็บข้อมูลวิธีสร้างเทมเพลตสำหรับพื้นที่เก็บข้อมูล
• วิธีใช้ GitHub: เกี่ยวกับที่เก็บข้อมูลเกี่ยวกับที่เก็บข้อมูล
• วิธีใช้ GitHub: การสร้างพื้นที่เก็บข้อมูลจากเทมเพลตวิธีสร้างโปรเจ็กต์ใหม่โดยใช้เทมเพลต
• วิธีใช้ GitHub: การให้สิทธิ์การใช้งานคำอธิบายพื้นที่เก็บข้อมูลของการอนุญาตสำหรับโปรเจ็กต์
• วิธีใช้ GitHub: สร้างคำอธิบาย repoของการสร้างพื้นที่เก็บข้อมูล
• เคล็ดลับ Open Source Guidesสำหรับการสร้าง/อธิบายโครงการโอเพ่นซอร์ส
• วิธีใช้ GitHub: การเพิ่มเทมเพลตคำขอดึง - การสร้างเทมเพลตสำหรับคำขอดึง

บทความของฉันเพิ่มเติม

• แก้ไขจุดบกพร่องใน Intellij IDEA: คำแนะนำสำหรับผู้เริ่มต้น
• คำแนะนำในการสร้างไคลเอนต์สำหรับ Skyscanner API และการเผยแพร่ใน jCenter และ Maven Central [ตอนที่ 1]
• คำแนะนำในการสร้างไคลเอนต์สำหรับ Skyscanner API และการเผยแพร่ใน jCenter และ Maven Central [ตอนที่ 2]
• การสร้างระบบติดตามราคาตั๋วเครื่องบิน: คำแนะนำทีละขั้นตอน [ตอนที่ 1]
• การสร้างระบบติดตามราคาตั๋วเครื่องบิน: คำแนะนำทีละขั้นตอน [ตอนที่ 2]
• การสร้างระบบติดตามราคาตั๋วเครื่องบิน: คำแนะนำทีละขั้นตอน [ตอนที่ 3]
• การบันทึก: อะไร อย่างไร ที่ไหน และด้วยอะไร?
• การทดสอบสัมภาษณ์กลายเป็นห้องสมุดโอเพ่นซอร์สได้อย่างไร
• ประวัติความสำเร็จ การเขียนโปรแกรม 20 ชั่วโมงต่อสัปดาห์ ปริญญาโท และชีวิตส่วนตัว
• หางานได้อย่างไร? ข้อแนะนำในการส่งเรซูเม่