为了帮助你快速上手 GitLab,这里列出了一些推荐的后续步骤。
已经是专家了?只需编辑此 README.md 并让它成为你自己的。想要更简单?使用底部的模板!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.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 中)。
告诉人们可以去哪里寻求帮助。可以是问题跟踪器、聊天室、电子邮件地址等的任意组合。
如果你对未来版本的发布有想法,最好在 README 中列出它们。
说明你是否对贡献持开放态度,以及你接受贡献的要求是什么。
对于想要为你的项目做出改变的人,有一些关于如何开始的文档会很有帮助。也许他们需要运行一个脚本,或者设置一些环境变量。请明确这些步骤。这些说明对你未来的自己也可能有用。
你还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保高代码质量并降低更改无意中破坏某些东西的可能性。如果测试需要外部设置(例如在浏览器中测试时需要启动 Selenium 服务器),那么包含运行测试的说明尤其有帮助。
对那些为项目做出贡献的人表达感谢。
对于开源项目,说明其许可方式。
如果你在项目上精力或时间不足,请在 README 顶部添加一条说明,指出开发已放缓或完全停止。有人可能会分叉你的项目,或自愿作为维护者或所有者介入,使你的项目得以继续。你也可以明确请求维护者。