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

วิธีรับดาว GitHub สำหรับโครงการโอเพนซอร์ส

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

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

ทำให้การเข้าชมที่เก็บโค้ดครั้งแรกมีประโยชน์

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

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

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

ค้นหาผู้อ่านกลุ่มแรกที่เกี่ยวข้อง

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

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

ขอดาวหลังจากมอบสิ่งที่มีประโยชน์

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

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

บันทึกสิ่งที่เรียนรู้ทุกสัปดาห์

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

ตัวอย่างเช่น หากผู้อ่านห้าคนถามวิธีตั้งค่าโทเคน ให้ย้ายคำอธิบายการตั้งค่ามาไว้ก่อนตัวอย่าง แชร์ตัวอย่างที่แก้แล้วกับผู้อ่านเหล่านั้น แทนการประกาศเปิดตัวแบบทั่วไปอีกครั้ง

  • สัปดาห์ที่ 1: ตรวจสอบคู่มือเริ่มต้นอย่างรวดเร็วในสภาพแวดล้อมสะอาด
  • สัปดาห์ที่ 2: แชร์กรณีใช้งานหนึ่งกรณีและตอบข้อเสนอแนะ
  • สัปดาห์ที่ 3: เผยแพร่สิ่งที่แก้ไขและอธิบายการเปลี่ยนแปลง
  • สัปดาห์ที่ 4: ใช้ช่องทางที่สร้างบทสนทนาที่มีประโยชน์ต่อไป และทบทวนช่องทางที่เหลือ

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

จะรับดาว GitHub 100 ดวงแรกได้อย่างไร?

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

ติดดาวที่เก็บโค้ด GitHub โดยไม่เข้าสู่ระบบได้ไหม?

คุณดูที่เก็บโค้ดสาธารณะและ GitHubStart ได้โดยไม่มีบัญชีเว็บไซต์ แต่หากต้องการติดดาว ต้องเข้าสู่ระบบ GitHub ด้วยตนเอง GitHubStart ไม่ทำขั้นตอนนี้แทนคุณ

ดาวมากขึ้นหมายถึงผู้ใช้มากขึ้นหรือไม่?

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

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