我刚刚制作了一个程序,我想将其公开,但我不知道应该包含哪些内容。为了方便起见,我将它放在 github 上,但我找不到任何关于在存储库中包含什么的信息。显然,我包含了所有源文件,但由于它是一个 Java 程序,我是否应该有一个脚本来使用正确的参数启动程序,还是这是用户的责任?我应该让它在启动时运行,还是留给用户?我应该在存储库中包含哪些文件来安装该程序?(即Makefile
/script 将文件放在正确的目录中并进行任何其他更改)
更简单的是,开发人员有责任将什么纳入开源程序?安装/部署程序有哪些标准?
答案1
您可能想要选择一个许可证。https://en.wikipedia.org/wiki/Creative_Commons_license
您可以查看gitignore.io,它会创建一个 gitignore 文件,它可以帮助确定哪些文件不上传到 github。
我应该让它在启动时运行,还是将其留给用户来决定?
请不要让它在启动时自动运行,这可能会惹恼那些不想要或不期望这种行为的人(但你可以将其添加为想要使用它的人的选项)。
我应该在存储库中包含哪些文件来安装该程序?(即 Makefile/脚本将文件放在正确的目录中并进行任何其他更改)
您可以根据需要创建安装程序,但这并不是必需的。我想到的是 Inno Setup 之类的东西。https://en.wikipedia.org/wiki/Inno_Setup
我是否应该有一个脚本来使用正确的参数启动程序,或者这是用户的责任?
您可以这样做,但您也可以在 README.md 中解释如何使用它。
更简单地说,开发人员在开源程序中的责任是什么?
基本上没什么,除了源代码。你可以在网上发布类似这样的内容:System.out.println("Hello World!");
然后你就完成了。