编写开放源码Java的最佳实践

Question

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

我的目标是将我编写的模块作为开源发布。

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

Answer 1

我不确定是否会就“最佳做法”达成普遍协议，但你提到的项目可能有简单的答案：

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

我会考虑更多的。

Answer 2

请参阅Karl的“http://producingoss.com/ -源代码”一书。

Answer 3

如果您正在寻找特定的目录结构，为什么不看看现有的开源项目呢？我从雅加达公域开始，它是一个被大量使用的包。

如果没有任何统计数据来支持我，我会说许多项目使用类似于Maven指定的目录结构，即使它们不使用Maven本身(如果您能够通过Maven学习曲线，它在90%的时间内是一个很好的构建工具)。