Liste de vérification pour la publication d'une bibliothèque Open Source

Question

J'ai travaillé sur une bibliothèque de développement Web (pour le framework CodeIgniter) que j'espère bientôt publier.

Ce serait ma première contribution, et je n'ai jamais publié une bibliothèque open source dans le passé.

Je voulais faire appel à l'expérience de certains d'entre vous pour toutes les étapes à suivre avant de sortir. Je sais que les tests et la documentation sont essentiels ... quoi d'autre?

Answer 1

1. licence ...........
2. Emballage (par exemple tarball source, Debian repostory etc.)
3. Groupe de discussion
4. Issue Tracker
5. feed Nouvelles (pour les versions , les annonces de projets, etc.)
6. feuille de route
7. Liste des bogues connus ""
8. Caractéristiques Liste
9. Liste des non-objectifs
10. site Démo
11. Exemple d'utilisation

Bien sûr, vous pouvez libérer quelque chose avec beaucoup moins ... il se résume à quel point « appel » vous voulez que votre projet pour recueillir dans le public.

Answer 2

assurez-vous que votre code est clairement commenté, quelque chose qui était trivial pour mettre en œuvre des tentatives documentées.

Answer 3

Pour ajouter à la liste de jdupont,

Documentation - de nombreux projets OS deviennent populaires simplement parce qu'ils ont une meilleure documentation (le cas échéant) courte vidéo des principales caractéristiques, ou une série de courtes vidéos montrant des caractéristiques différentes. C'est souvent la première chose que je regarde. Si vous n'avez pas le temps de le faire, au moins quelques captures d'écran pour que les gens puissent avoir une idée de la façon dont les choses interagissent.