คู่มือโครงการ

ภาพตัวอย่างเมื่อแชร์ GitHub: ขนาด การตั้งค่า และรายการตรวจสอบ

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

ทีมบรรณาธิการ GitHubStart · อัปเดต

เตรียมไฟล์ให้ถูกต้อง

คำแนะนำปัจจุบันของ GitHub รองรับไฟล์ PNG, JPG หรือ GIF ที่เล็กกว่า 1 MB แนะนำอย่างน้อย 640 × 320 พิกเซล และ 1280 × 640 เพื่อการแสดงผลที่ดีที่สุด เริ่มจากผืนภาพ 2:1 ขนาดใหญ่กว่า แล้วตรวจสอบว่ายังอ่านออกเมื่อลดขนาดลงมาก

สำหรับเครื่องมือตรวจ CSV สมมติ อาจจัดวางชื่อโครงการ ข้อความ “ตรวจไฟล์ CSV ก่อนนำเข้า” และตัวอย่างง่าย ๆ จากข้อมูลเข้าไปยังข้อผิดพลาด อย่าอัดการทำงานในเทอร์มินัลทั้งชุดลงในภาพย่อ วางข้อความสำคัญห่างจากขอบเผื่อพื้นที่แชร์ครอบตัดภาพ

อัปโหลดและตรวจสอบลิงก์ที่แชร์

เปิด Settings ของคลังโค้ด หา Social preview เลือก Edit แล้วอัปโหลดภาพ แชร์ URL ของคลังโค้ดสาธารณะในปลายทางที่กลุ่มเป้าหมายจะเห็น และตรวจผลที่นั่น การอัปโหลดสำเร็จไม่ได้รับประกันว่าทุกแพลตฟอร์มจะเปลี่ยนภาพที่แคชไว้ทันที

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

ทำให้ภาพตัวอย่างสอดคล้องกับโครงการ

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

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

คำถามที่พบบ่อย

ภาพนี้เหมือนรูปประจำตัวเจ้าของคลังโค้ดหรือไม่?

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

ใช้พื้นหลังโปร่งใสได้หรือไม่?

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

ทำไมอัปโหลดแล้วจึงยังเห็นภาพเก่า?

ตรวจสอบก่อนว่าบันทึกภาพใหม่ไว้ในคลังโค้ดที่ถูกต้อง แพลตฟอร์มแชร์อาจเก็บภาพตัวอย่างไว้ในแคช และวิธีรีเฟรชแยกจากการตั้งค่าคลังโค้ด

เอกสารอ้างอิง