เครื่องมือสร้าง .gitignore

กฎแต่ละประเภทควรอยู่ที่ไหน?

Git อ่าน .gitignore ของโปรเจกต์, .git/info/exclude ที่ใช้เฉพาะที่เก็บโค้ด และไฟล์ส่วนตัวที่กำหนดด้วย core.excludesFile เมื่อคอมมิต .gitignore กฎของโปรเจกต์จะถูกแชร์ไปกับที่เก็บโค้ด ส่วนกฎส่วนตัวโดยทั่วไปมีผลเฉพาะบนคอมพิวเตอร์ของคุณ อ่านเพิ่มเติมในคู่มือกฎละเว้นของ Git และคู่มือการละเว้นไฟล์ของ GitHub

ตัวอย่าง: บริการ Node.js ที่มีสคริปต์ Python

เลือก Node.js และ Python ไฟล์ของโปรเจกต์จะรวมกฎสำหรับแพ็กเกจที่ติดตั้ง เช่น node_modules/, ผลลัพธ์จากการสร้างด้วย Node เช่น dist/ และไฟล์ที่ Python สร้าง เช่น __pycache__/ กับ .venv/ นอกจากนี้ยังละเว้นค่าใน .env ที่ใช้ในเครื่อง โดยยังเปิดทางให้ติดตาม .env.example ได้ หากใช้ Mac และ Visual Studio Code ให้เลือกตัวเลือกส่วนตัวเหล่านั้นเพื่อดูกฎแยกต่างหาก ตรวจสอบผลลัพธ์ทั้งสองส่วนกับที่เก็บโค้ดจริงก่อนบันทึก

เครื่องมือสร้างกฎจากแม่แบบที่เลือก ไม่สามารถอ่านไฟล์ของคุณหรือรู้ว่าโฟลเดอร์ dist/ เป็นผลลัพธ์ที่สร้างขึ้นหรือซอร์สโค้ดที่ควรคอมมิต หากกฎขัดกับโปรเจกต์ ให้จำกัดขอบเขตหรือลบกฎนั้น ใช้ git check-ignore -v path/to/file เพื่อดูว่ากฎใดมีผลกับไฟล์ที่ Git ยังไม่ติดตาม ชุดแม่แบบของ GitHub ช่วยใช้อ้างอิงกฎตามเทคโนโลยีและโปรแกรมแก้ไขโค้ดได้ แต่ยังต้องตรวจสอบที่เก็บโค้ดของคุณเอง

ไฟล์สภาพแวดล้อมและไฟล์ล็อกเวอร์ชัน

การละเว้น .env ช่วยป้องกันไม่ให้ข้อมูลลับในเครื่องเข้าไปในคอมมิตใหม่ แต่ไม่ลบความลับที่เคยคอมมิตแล้ว หากความลับอยู่ในประวัติ Git ให้หยุดติดตามไฟล์ ตรวจสอบว่าข้อมูลถูกคัดลอกไปที่ใดบ้าง และเปลี่ยนข้อมูลรับรองนั้น เก็บ .env.example ที่ผ่านการล้างข้อมูลไว้ได้เฉพาะเมื่อมีค่าตัวอย่างแทนความลับจริง ไฟล์ .gitignore ที่สร้างขึ้นมีข้อยกเว้น !.env.example อยู่แล้ว เพื่อไม่ให้กฎ .env.* ที่ครอบคลุมกว่าซ่อนไฟล์ตัวอย่าง หากแก้ไขกฎ ให้คงข้อยกเว้นนี้ไว้

สำหรับแอปพลิเคชัน ควรคอมมิตไฟล์ล็อกเวอร์ชันแพ็กเกจเพื่อให้ติดตั้งเวอร์ชันเดิมซ้ำได้ npm แนะนำให้คอมมิต package-lock.json และ Composer แนะนำให้คอมมิต composer.lock โปรเจกต์ที่เป็นไลบรารีอาจมีแนวทางต่างกัน ให้ยึดนโยบายการสร้างและเผยแพร่ของโปรเจกต์