Java发布工程的良好实践

Question

我有一个相当简单的开源Java项目.这个过程对我来说是新的,我习惯只为自己编写程序.在Java中发布开源项目时需要注意哪些好的做法？

以下是我能想到的一些事情,你能建议别人吗？

• 版本控制存储库(你用什么来解释相关的标签/分支？外部自述文件？)
• 在代码中包含适当的开源许可证
• 包括预先打包的可执行JAR文件,包括文件名中的版本号
• 某种README文件解释了构建/运行软件所需的外部依赖关系(有什么文件名和放在哪里的常见约定？)
• 项目的网页,在源代码和/或可执行文件中有一个链接,以防有人首先获得源代码或可执行文件(而不是通过相关网页)

Answer 1

你应该做的一件事(因为它是Java)是为你的代码生成Javadocs.这意味着使用Javadoc表示法注释类和方法,以便更容易阅读其他人.

Answer 2

您也可以使用Maven发布代码.有了它,可以很容易地为您的项目创建一个站点,指定依赖项,优化发布......例如,Apache的Commons项目使用Maven.

Answer 3

从签入评论生成变更日志。单独创建一个发行说明，解释您在每个版本中修复/添加的内容。