
为了让您轻松上手 GitLab,以下是一些推荐的后续步骤。
已经是高手了?只需编辑此 README.md 并将其变成您自己的内容。想让它更简单?使用底部的模板!
cd existing_repo
git remote add origin https://gitlab.com/valtersit/ruby-cve-scanner.git
git branch -M main
git push -uf origin main
使用 GitLab 内置的持续集成功能。
当你准备好将此 README 变为你自己的内容时,只需编辑此文件并使用下方便捷的模板(或者随意按你想要的方式组织它——这只是一个起点!)。感谢 makeareadme.com 提供此模板。
每个项目都不尽相同,因此请考虑哪些部分适用于你的项目。模板中使用的部分是对大多数开源项目的建议。另请记住,虽然 README 可能过长过细,但过长总比过短好。如果你认为你的 README 太长,请考虑使用另一种形式的文档,而不是删减信息。
为你的项目选择一个能自我说明的名称。
让人们具体了解你的项目能做什么。提供背景信息,并添加指向访客可能不熟悉的任何参考资料的链接。也可以在此处添加“功能”列表或“背景”子章节。如果你的项目存在替代方案,这里是列出差异化因素的好地方。
在某些 README 中,你可能会看到传达元数据的小图片,例如项目的所有测试是否通过。你可以使用 Shields 向你的 README 添加一些徽章。许多服务也提供了添加徽章的说明。
根据你正在制作的内容,包含截图甚至视频可能是个好主意(你会经常看到 GIF 而不是实际视频)。像 ttygif 这样的工具可以提供帮助,但请查看 Asciinema 以了解更复杂的方法。
在特定的生态系统中,可能存在一种通用的安装方式,例如使用 Yarn、NuGet 或 Homebrew。但是,请考虑到阅读你 README 的人可能是新手,希望获得更多指导。列出具体步骤有助于消除歧义,让人们尽快使用你的项目。如果它只在特定环境中运行,例如特定的编程语言版本或操作系统,或者有需要手动安装的依赖项,还请添加“要求”子章节。
大量使用示例,并尽可能展示预期输出。将你能演示的最小用法示例内联展示会很有帮助,同时提供指向更复杂示例的链接(如果这些示例太长而无法合理地包含在 README 中)。
告诉人们可以去哪里寻求帮助。它可以是问题跟踪器、聊天室、电子邮件地址等的任意组合。
如果你对未来版本有想法,最好在 README 中列出它们。
说明你是否接受贡献以及接受贡献的要求是什么。
对于希望修改你项目的人而言,提供一些关于如何入门的文档会很有帮助。也许有他们应当运行的脚本,或者需要设置的环境变量。请将这些步骤明确写出。这些说明对你未来的自己也可能有用。
你还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保较高的代码质量,并降低改动无意中破坏某些功能的可能性。如果运行测试需要外部环境配置,例如为在浏览器中进行测试而启动 Selenium 服务器,那么提供运行测试的说明尤其有帮助。
向为项目做出贡献的人表达你的感谢。
对于开源项目,请说明其采用何种许可证。
如果你已没有精力或时间继续你的项目,请在 README 顶部注明开发已放缓或完全停止。其他人可能会选择 fork 你的项目,或自愿担任维护者或负责人,从而让你的项目得以延续。你也可以明确招募维护者。