รายการตรวจสอบสำหรับการเริ่มต้นโครงการโอเพนซอร์ส [ปิด]


50

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

หากสร้างรายการตรวจสอบเหนือสิ่งสำคัญที่ต้องทำคุณจะรวมอะไรไว้บ้าง


1
+1 คำถามที่ดี ฉันขอแนะนำ: gawande.com/the-checklist-manifesto
JeffO

2
ฉันขอแนะนำหนังสือของ Karl Fogel (หนึ่งในผู้เขียนโค่นล้มดั้งเดิม) การผลิตซอฟต์แวร์โอเพนซอร์ซ - วิธีการดำเนินโครงการซอฟต์แวร์ฟรีที่ประสบความสำเร็จ มันเป็นหนังสือ O'Reilly
ไมเคิล

การผลิตซอฟต์แวร์โอเพนซอร์ซโดยคาร์ลโฟเกลควรช่วยคุณได้ หนังสือเล่มนี้มีให้บริการออนไลน์ทั้งหมด
โคโยตี้ 21

คำตอบ:


34

สิ่งที่สำคัญที่สุดคือ:

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

สิ่งที่ฉันให้ความสำคัญเป็นลำดับต้นคือ:

  • มีความเรียบง่าย "มันคืออะไร" เว็บไซต์ที่มีลิงก์ไปยังฟอรัมการสนทนาบางส่วน (ไม่ว่าจะเป็นอีเมลหรือแชท) และไปยังที่เก็บซอร์สโค้ด
  • ตรวจสอบให้แน่ใจว่าโค้ดคอมไพล์แล้วและใช้งานได้ปกติอย่าคอมมิทเวิร์คที่กำลังคืบหน้าหรือครึ่งลาบนสาขาหลักที่แยกสิ่งต่าง ๆ เพราะงานของคนอื่นจะหยุดชะงัก
  • ใส่ไฟล์ลิขสิทธิ์ลงในที่เก็บรหัสด้วยลิขสิทธิ์ที่รู้จักกันดีและทำเครื่องหมายเจ้าของลิขสิทธิ์ (อาจเป็นคุณหรือ บริษัท ของคุณ) อย่าละทิ้งสิทธิ์ใช้งานสร้างใบอนุญาตหรือใช้ใบอนุญาตคลุมเครือ
  • มีคำแนะนำเกี่ยวกับวิธีบริจาคพูดในไฟล์แฮ็คหรือรวมไว้ใน README ของคุณ นี้ควรรวมถึงสถานที่ที่จะส่งแพทช์, วิธีการจัดรูปแบบแพทช์, กฎการเยื้องรหัส, อนุสัญญาสำคัญอื่น ๆ ของโครงการ
  • มีคำแนะนำเกี่ยวกับวิธีการรายงานข้อบกพร่อง
  • มีประโยชน์ในรายชื่อผู้รับจดหมายหรือฟอรั่มของคุณ

หลังจากลำดับความสำคัญเหล่านั้นฉันจะพูดว่า:

  • เอกสารประกอบ (สิ่งนี้ช่วยให้คุณทำงานในรายชื่อผู้รับจดหมาย ... สร้างคำถามที่พบบ่อยจากการโพสต์รายการของคุณเป็นการเริ่มต้นที่ง่าย)
  • พยายามทำสิ่งต่าง ๆ ในลักษณะ "ปกติ" (อย่าประดิษฐ์ระบบสร้างของคุณเองหรือใช้สิ่งแปลก ๆ อย่าใช้การเว้นวรรค 1 ช่องไม่ต้องแปลก ๆ โดยทั่วไปเพราะมันเพิ่มเส้นโค้งการเรียนรู้)
  • ส่งเสริมโครงการของคุณ การตลาดการตลาดการตลาด คุณต้องมีบล็อกและไซต์ข่าวและสิ่งต่าง ๆ เช่นนั้นเพื่อปกปิดคุณและเมื่อผู้คนสนใจคุณต้องพูดคุยกับพวกเขาและตรวจสอบให้แน่ใจว่าพวกเขาทำให้มันทำงานได้ อาจพูดถึงโครงการของคุณในฟอรัมสำหรับโครงการที่เกี่ยวข้อง
  • ตรวจสอบและยอมรับแพทช์อย่างรวดเร็วที่สุดเท่าที่จะทำได้โดยมนุษย์ ทันทีสมบูรณ์แบบ มากกว่าสองสามวันและคุณสูญเสียผู้คนมากมาย
  • ตอบอีเมลเกี่ยวกับโครงการให้เร็วที่สุดเท่าที่จะทำได้อย่างมนุษย์ปุถุชน
  • สร้างบรรยากาศต้อนรับ / เป็นบวก / สนุกสนาน อย่ากระตุก พูดได้โปรดและขอบคุณและยื่นมือออกมาสรรเสริญ ไล่ล่าสัตว์ป่าชนิดใด ๆ ที่ปรากฏขึ้นและเริ่มวางยาพิษชุมชน พยายามที่จะพบปะผู้คนด้วยตนเองเมื่อคุณสามารถและสร้างพันธบัตร

ปัญหาทางกฎหมายที่อาจเกิดขึ้น วิธีการที่ทำให้แน่ใจว่าการใช้งานไม่ได้มีอัลกอริทึมที่จดสิทธิบัตร?
Den

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

17

สำหรับผู้เริ่มต้นลดอุปสรรคในการเข้าหมายความว่า:

  • ทำให้ติดตั้งง่าย
  • ทำให้ง่ายต่อการปรับเปลี่ยน
  • ทำให้ง่ายต่อการค้นหาโครงการของคุณ
  • เพียงทำทุกสิ่งที่คุณต้องการทำง่าย ๆ

อย่างไร?

  • ตอบคำถามทุกข้อที่คุณนึกถึงในเอกสารของคุณ
  • สร้างระบบ build ที่ใช้งานง่าย
  • ทำความสะอาดรหัสของคุณไม่มีใครชอบทำงานกับรหัสสปาเก็ตตี้
  • ทำสิ่งที่ผู้คนต้องการ
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.