Checkliste für eine Open-Source-Bibliothek Freigabe [geschlossen]

Question

Ich habe auf einer Web-Entwicklungsbibliothek gearbeitet (für den CodeIgniter-Framework), die ich hoffe, bald zu lösen.

Das wäre mein erster Beitrag überhaupt sein, und ich habe nie veröffentlichte eine Open-Source-Bibliothek in der Vergangenheit.

wollte ich auf die Erfahrung von einigen von Ihnen appellieren für alle Schritte zu folgen, vor dem Loslassen. Ich weiß, dass Tests und Dokumentation sind die Schlüssel ... was sonst?

Answer 1

1. Lizenzierung ...........
2. Verpackung (z Quellkodearchivs, Debian repostory etc.)
3. Discussion Group
4. Issue Tracker
5. News-Feed (für Veröffentlichungen, Projektankündigungen etc.)
6. Roadmap
7. Liste der bekannten "bugs"
8. Features List
9. Liste der Nicht-Ziele
10. Demo-Website
11. Beispiel für die Verwendung

Natürlich kann man etwas mit viel weniger freigeben ... es kommt darauf an, wie viel „Aufruf“ Sie wollen Ihr Projekt in der Öffentlichkeit zu sammeln.

Answer 2

stellen Sie sicher, dass Ihr Code eindeutig kommentiert, alles, was trival war Versuche dokumentiert umzusetzen.

Answer 3

Um zu jdupont Liste hinzuzufügen,

Dokumentation - viele OS-Projekte populär geworden, nur weil sie eine bessere Dokumentation haben (Falls zutreffend) Kurzes Video von wichtigen Funktionen, oder eine Reihe von kurzen Videos verschiedene Funktionen vorführt. Das ist oft das erste, was ich sehe. Wenn keine Zeit für sie haben, zumindest einige Sreenshots so können die Menschen ein Gefühl dafür, wie die Dinge zu interagieren.