วิธีปฏิบัติที่ดีที่สุด / ไม่ดีสำหรับการแบ่งปันรหัส? [ปิด]

ยิ่งฉันสำรวจGithubมากเท่าไหร่ฉันก็ยิ่งชอบมากเท่านั้น ฉันสนุกกับการเขียนโปรแกรมสังคมมากขึ้น

ฉันอยากรู้ว่าถ้ามีวิธีปฏิบัติที่ไม่ดีใด ๆที่โปรแกรมเมอร์ควรหลีกเลี่ยงในการแบ่งปันรหัสของพวกเขากับแต่ละอื่น ๆ และในการตั้งชื่อแนวปฏิบัติที่ไม่ดีแนวทางปฏิบัติที่ดีที่สุดสำหรับการแบ่งปันรหัสคืออะไร

ตัวอย่างเช่น:

มันคือการปฏิบัติที่ไม่ดีสำหรับ repo เดียวที่จะมีสคริปต์หลาย / โครงการที่ชื่อ'MiscProjects' ? ที่ซึ่ง repo นี้ตามชื่อแนะนำคือชุดของสคริปต์และโครงการขนาดเล็กอื่น ๆ นี่อาจคล้ายกับวิธีที่โปรแกรมเมอร์จัดโครงการบนที่เก็บข้อมูลในเครื่องของเขา / เธอ แต่มันอาจจะไม่เหมาะสำหรับการแชร์รหัส

บางทีถ้า README / เอกสารที่ดีเสร็จสิ้นมันจะดีกว่าไหม? หรือตราบใดที่มีการบันทึกไว้อย่างดี

ในขณะที่ไม่มีการปฏิบัติที่ไม่ดี 'ตั้งอยู่ในหินเช่นเดียวกันกับระบบการควบคุมรุ่นอื่น ๆที่มีการประชุม

repo Git ของคุณควรเล็กที่สุด หากคุณมาจากโมดูล CVS / SVN เป็นเรื่องปกติที่จะมีที่เก็บแบบโครงสร้างเดียวซึ่งสามารถประกอบด้วยที่เก็บหลายแห่งสำหรับโครงการหลายโครงการ วิธี Gitคือการแยกเหล่านี้และมี Repos Git แยกต่างหากสำหรับแต่ละโครงการ เหตุผลคือ:

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

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

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