ฉันจะเตรียมและอัปโหลดโครงการที่มีอยู่ไปยัง GitHub ได้อย่างไร

เสร็จสมบูรณ์เมื่อ

ในหน่วยนี้ เราจะกล่าวถึงข้อควรพิจารณาที่สําคัญสําหรับการอัปโหลดโครงการไปยัง GitHub

ทําไมต้องอัปโหลดไปยัง GitHub?

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

การควบคุมเวอร์ชัน

GitHub ใช้เฉพาะ Gitซึ่งเป็นระบบควบคุมเวอร์ชันที่ดีที่สุด อย่างไรก็ตาม Git มีความซับซ้อนอย่างไม่น่าเชื่อและสามารถสร้างสถานการณ์ที่ซับซ้อนบางอย่างสําหรับการทํางานกับโค้ดที่ทีมของคุณอาจไม่พบ สาขา และคําขอดึงข้อมูล เป็นส่วนพื้นฐานของชีวิตประจําวันสําหรับนักพัฒนาที่ใช้ Git เพื่อทําความเข้าใจเวลาและวิธีการใช้งานอย่างมีประสิทธิภาพเป็นสิ่งจําเป็นที่จะประสบความสําเร็จบน GitHub คุณควรทําให้ทีมของคุณคุ้นเคยกับ โฟลว์ GitHub เพื่อให้คุณสามารถเริ่มต้นทํางานได้

เก็บโค้ดของคุณไว้ในระบบคลาวด์

รหัสโครงการจํานวนมากจะยังคงถูกจัดเก็บไว้เฉพาะบนเครื่องสําหรับนักพัฒนา เมื่อคุณอัปโหลดไปยัง GitHub คุณกําลังย้ายรหัสของคุณไปยังแพลตฟอร์มคลาวด์ของ GitHub ซึ่งสมาชิกในทีมสามารถเข้าถึงได้อย่างง่ายดายจากทุกที่ การเปลี่ยนแปลงนี้ให้โอกาสที่ดีในการตรวจสอบนโยบายของทีมของคุณสําหรับชนิดไฟล์และข้อมูลที่คุณเก็บไว้ในการควบคุมเวอร์ชัน ตามแนวทางปฏิบัติที่ดีที่สุด คุณควรสันนิษฐานว่า สิ่งใดก็ตามที่คุณยืนยันกับ GitHub อาจได้รับผลกระทบ ดังนั้นตรวจสอบให้แน่ใจว่าไม่ได้รวมข้อมูลที่สําคัญ เช่น คีย์ API รหัสผ่าน หรือไฟล์อื่น ๆ ที่มีข้อมูลเปรียบเทียบ

โน้ต

GitHub มีทั้งที่เก็บแบบสาธารณะและส่วนตัว และส่วนควบคุมการเข้าถึงที่แยกย่อยสําหรับส่วนต่าง ๆ ของที่เก็บ กรานูลาริตี้นี้ช่วยให้คุณสามารถควบคุมว่าโครงการของคุณจะปรากฏให้ใครและการดําเนินการใดที่ผู้ใช้ที่ระบุสามารถดําเนินการได้

การร่วมมือ

GitHub ให้การสนับสนุนที่ยอดเยี่ยมสําหรับการทํางานร่วมกันเป็นทีมผ่านคุณลักษณะต่าง ๆ เช่น ปัญหา คําขอดึงข้อมูล และการตรวจสอบโค้ด อย่างไรก็ตาม โฟลว์ GitHub อาจแตกต่างจากแนวทางปฏิบัติที่ทีมของคุณคุ้นเคย ควรพิจารณาว่าทีมของคุณอาจปรับตัวเข้ากับ GitHub อย่างไร และคุณควรรักษากระบวนการที่มีอยู่หรือไม่

ถ้าโครงการของคุณเป็นโครงการแบบโอเพนซอร์สที่อนุญาตให้ผู้สนับสนุนภายนอกสามารถเลือกได้ดีกว่า GitHub เพื่อเพิ่มประโยชน์เหล่านั้น

อัปโหลดไปยัง GitHub

ข้อควรพิจารณาของแผน

สิ่งสําคัญที่สุดที่ควรพิจารณาก่อนดําเนินการอัปโหลดของคุณไปยัง GitHub คือคุณต้องเก็บสิ่งใดไว้นอกเหนือจากสถานะปัจจุบันของแหล่งข้อมูลของคุณหรือไม่ ตัวอย่างเช่น คุณอาจใช้ซอฟต์แวร์สเปรดชีตหรือการจัดการโครงการเพื่อติดตามข้อบกพร่องที่คุณวางแผนที่จะแก้ไข การสนับสนุนสําหรับการโยกย้ายรายการเหล่านี้แตกต่างกันไปตามแพลตฟอร์มและพร้อมใช้งานโดยทั่วไปจากโครงการชุมชน มอดูลนี้ไม่ครอบคลุมถึงการโยกย้ายข้อมูลประเภทนั้น

จัดการไฟล์ไบนารีที่จัดเก็บไว้ในโครงการของคุณในขณะนี้

แนวทางปฏิบัติที่ดีที่สุดที่เก็บ GitHub ควรถูกจํากัดไว้ที่ไฟล์ที่จําเป็นสําหรับการสร้างโครงการ หลีกเลี่ยงการบันทึกไฟล์ไบนารีขนาดใหญ่ เช่น วัตถุบิลท์ ไฟล์ไบนารีเช่นสเปรดชีตและงานนําเสนอเหมาะกว่าที่จะติดตามบนพอร์ทัลที่เข้าใจวิธีการให้บริการและวางเวอร์ชันอย่างถูกต้อง หากคุณมีความต้องการไฟล์ไบนารีขนาดใหญ่ให้พิจารณาใช้ส่วนขยาย Git Git LFS (การจัดเก็บไฟล์ขนาดใหญ่)

สร้างไฟล์ Git ที่สําคัญ เช่น gitignore

Git สนับสนุนไฟล์ .gitignore เพื่อช่วยบังคับใช้นโยบายการควบคุมไฟล์ แฟ้มเหล่านี้จะกําหนดรูปแบบการค้นหาที่ใช้ในการแยกแฟ้มและโฟลเดอร์ออกจากการติดตามตัวควบคุมแหล่งข้อมูล ตัวอย่างต่อไปนี้แยก โฟลเดอร์ ใด ๆ ที่เรียกว่า bin หรือ ช่องเก็บและเนื้อหามาจากการติดตามตัวควบคุมแหล่งที่มา

[Bb]in/

เรียนรู้เพิ่มเติมเกี่ยวกับ ละเว้นแฟ้ม นอกจากนี้ตรวจสอบคอลเลกชันของไฟล์ .gitignore เริ่มต้นที่นําเสนอสําหรับแพลตฟอร์มต่าง ๆ ในที่เก็บ gitignore

มีไฟล์อื่นๆ อีกหลายไฟล์ที่ใช้กันทั่วไปในโครงการ GitHub เพื่ออธิบายนโยบายที่แตกต่างกันสําหรับผู้บริโภคและผู้ร่วมให้ข้อมูลในที่เก็บ แม้ว่าโครงการของคุณจะเป็นส่วนตัวและจํากัดให้กับผู้ชมกลุ่มใดกลุ่มหนึ่ง แต่ก็ยังคงมีประโยชน์ในการอธิบายนโยบายเหล่านี้อย่างชัดเจน แม้ว่าจะไม่จําเป็นต้องใช้ไฟล์เหล่านี้ ไฟล์ทั่วไปบางไฟล์จะแสดงอยู่ที่นี่

แฟ้ม	วัตถุประสงค์
README.md	หน้าเริ่มต้นสําหรับไดเรกทอรี หน้านี้จะแสดงเมื่อดูไดเรกทอรีบน GitHub
LICENSE.md	ไฟล์นี้มีใบอนุญาตภายใต้รหัสที่ให้ไว้
CONTRIBUTING.md	อธิบายว่าผู้ใช้ควรมีส่วนร่วมในโครงการอย่างไร เช่น ความคาดหวังของคําขอดึงข้อมูล
SECURITY.md	อธิบายนโยบายความปลอดภัยสําหรับโครงการ ไฟล์นี้มีคําแนะนําแก่ผู้ใช้ที่ต้องการส่งรหัสที่เกี่ยวข้องกับความปลอดภัยหรือคําติชมที่ไม่ควรเปิดเผยต่อสาธารณะก่อนที่จะได้รับการแก้ไข

เรียนรู้เพิ่มเติมเกี่ยวกับ การตั้งค่าโครงการของคุณสําหรับการร่วมให้ข้อมูลสุขภาพ

อัปโหลดโครงการของคุณไปยัง GitHub

เมื่อที่เก็บของคุณได้รับการเตรียมพร้อมสําหรับการอัปโหลดแล้ว ให้สร้างที่เก็บข้อมูลบน GitHub เมื่อสร้างแล้ว ให้นําทางไปยังแท็บ Code ของที่เก็บ GitHub ของคุณ มุมมองนี้ให้หลายวิธีในการอัปโหลดรหัสโครงการของคุณ

เราขอแนะนําให้คุณใช้ git ไคลเอ็นต์หรือเครื่องมือที่เป็นมิตรกับ Git เพื่ออัปโหลดแหล่งข้อมูลของคุณ อีกวิธีหนึ่งคือ คุณสามารถอัปโหลดไฟล์ของคุณด้วยตนเองโดยใช้ สร้างไฟล์ใหม่ ลิงก์ ในระยะยาว คุณมีแนวโน้มที่จะพบว่าการใช้ไคลเอ็นต์ git เป็นวิธีที่ดีที่สุดในการจัดการการเปลี่ยนแปลง สาขา และอื่น ๆ