发布开源库的清单

Question

我一直在研究一个我很快希望发布的Web开发库（用于CodeIgniter框架）。

这将是我有史以来的第一次贡献，我过去从未发布过开源库。

我想呼吁你们中的一些人在发布之前要遵循的任何步骤。我知道测试和文档是关键...还有什么？

Answer 1

1. 许可...........
2. 包装（例如来源tarball，Debian repostory等）
3. 讨论组
4. 问题跟踪器
5. 新闻Feed（发布，项目公告等）
6. 路线图
7. 已知“错误”列表
8. 功能列表
9. 非目标列表
10. 演示网站
11. 使用示例

当然，你可以用更少的东西发布一些内容......这取决于你希望你的项目在公众中收集多少“吸引力”。

Answer 2

确保您的代码有明确的评论，任何有助于实施尝试记录的事情。

Answer 3

要添加到jdupont的列表，

文档 - 许多操作系统项目因其具有更好的文档而变得流行 （如果适用）主要功能的短视频，或显示不同功能的一系列短视频。这通常是我看到的第一件事。如果没有时间，至少有一些人可以让人们了解事物的相互作用。