编写开源Java的最佳实践

Question

在哪里可以找到编写开源Java代码的最佳实践？我不是在寻找有关如何正确编写代码的指示,而是寻找分发,打包,文档以及除.java文件之外的所有其他方面的指导.

我的目标是采用我编写的模块并将其作为开源发布.

编辑 - 我仍然缺少关于zip文件应该包含什么的直接,具体的说明.是否有这样的惯例,或者我应该选择一些合理的结构？

Answer 1

我不确定是否会就"最佳实践"达成普遍协议,但您提到的项目可能有简单的答案:

1. 使用java.net或Sourceforge可以轻松分发.您将使用他们的标准发布您的代码,
2. 打包将是ZIP文件.创建MD5哈希是一个好主意,使客户端可以检查其下载的完整性.
3. 文档 - 是的,请多多.有单独的javadocs和参考指南,展示如何使用你的东西.
4. 有一个允许匿名访问的公共SVN,这样人们就可以自己获取并构建最新的代码.
5. 有一个bug跟踪器,允许人们报告错误,新功能等.
6. 设置维基以供讨论,反馈等.
7. Maven已经成为一种开源标准.为那些想要签出并构建代码的冒险人士提供一个好的pom.xml.
8. 单元测试和良好的代码覆盖将有助于证明您对质量的承诺.

我会试着想更多.

Answer 2

请参阅Karl Fogel的书籍http://producingoss.com/-可在线获取的资料.