在制作项目开源时要考虑什么？

Question

我即将发布一个项目作为开源，并且非常希望对一些事情提供一些反馈：

1. 代码非常干净，但版本控制历史记录不是。错误，调试代码，可能是不合适的代码等。我应该在发布前清除历史记录，还是将其导入公共存储库？

2. 我应该优先制作教程，功能解释或api文档吗？

3. 让人们容易进入新项目的其他想法是什么？

Answer 1

以我非常谦虚的意见：

1）如果您准备开源，请为您的代码感到自豪。我们都知道一路上都有错误和错误。还会有更多，所以不要觉得你不能公开展示那些。你可以！

2）绝对。也许就是这样，也是因为这是人们使用你产品的顺序。他们必须在决定使用之前使用您的软件。

3）我能给出的最好的建议是有明确的构建说明，希望有脚本来帮助人们配置环境。开源软件的一个常见瘟疫是要求新开发人员下载大量的库并配置他们的盒子恰到好处以便能够构建软件。对我来说，这非常令人沮丧，可以让我很快离开。

祝你好运！

Answer 2

1. 完全是您的选择，除非您使用了您没有发行权的受版权保护的代码，或者是否存在涉及再分发，信用等的问题。

2. 很难说不知道它是什么。你需要什么才能使用它？你想先看到什么？ （可能是教程......）

3. 也许是一个从头到尾的例子，包括安装。也许您应该在运行虚拟环境或新的操作系统安装时遇到麻烦，因此您确信您的安装说明可以处理所有内容。

Answer 3

1. 将一些提交压缩在一起应该很容易，而且努力是值得的。开发人员通常会查看历史记录，以深入了解项目的设计方式。
2. 当然。你可以做的最少的是获得一些像Doxygen这样的文档引擎来生成文档。此时教程可能是不必要的;社区将为您编写教程，前提是代码记录良好。
3. 良好的包装总是有帮助的。为多个体系结构生成预编译的二进制文件，如果可行，创建RPM和DEB。这大大降低了进入障碍。没有人为他们不使用的软件做出贡献。您还可以使用像Bugzilla这样的错误跟踪器，或使用Launchpad或Trac等集成解决方案。还设置了邮件列表和IRC频道。这将有助于建立一个社区。