1 个不稳定版本
| 0.0.1 | 2024年2月13日 |
|---|
3 在 #exploring 中
8KB
caduceus
入门指南
为了方便您在GitLab上开始使用，以下是一些推荐的下一步操作。
已经是老手？只需编辑此README.md并将其变为自己的，想让它变得简单？使用底部的模板！
添加您的文件
cd existing_repo
git remote add origin https://gitlab.com/UWyo-SSC/cedar/caduceus.git
git branch -M main
git push -uf origin main
与您的工具集成
与您的团队协作
测试和部署
使用GitLab内置的持续集成。
- 开始使用GitLab CI/CD
- 使用静态应用安全测试（SAST）分析您的代码以识别已知漏洞
- 使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS
- 使用基于拉的部署以改善Kubernetes管理
- 设置受保护的环境
编辑此README
当您准备好将此README变为自己的时，只需编辑此文件并使用下面的实用模板（或者您也可以随意组织它 - 这只是一个起点！）感谢makeareadme.com提供此模板。
良好README的建议
每个项目都是不同的，因此请考虑哪些部分适用于您的项目。模板中使用的部分是最适合大多数开源项目的建议。同时请注意，虽然README可以太长或太详细，但太长总比太短好。如果您认为您的README太长，考虑使用其他形式的文档，而不是删除信息。
名称
为您的项目选择一个易于理解的名称。
描述
让人们知道您的项目具体能做什么。提供背景信息，并添加任何可能使访客感到陌生的参考链接。也可以在此处添加功能列表或背景子部分。如果有与您的项目不同的替代方案，这也是列出不同之处的好地方。
徽章
在一些README文件中，你可能看到一些小图片，它们传达了元数据，例如项目中的所有测试是否通过。你可以使用Shields为你的README添加一些图片。许多服务也提供了添加徽章的说明。
视觉元素
根据你正在制作的内容，包括截图甚至视频（你通常会看到GIF而不是实际视频）是个好主意。例如ttygif这样的工具可以帮助，但检查Asciinema以获取更复杂的方法。
安装
在特定的生态系统内，可能有常见的安装方式，例如使用Yarn、NuGet或Homebrew。然而，考虑到阅读你的README的人可能是一个新手，他们可能需要更多指导。列出具体的步骤有助于消除歧义，并尽可能快地让人们使用你的项目。如果它仅在特定的环境中运行，例如特定的编程语言版本或操作系统，或者有需要手动安装的依赖项，也请添加一个“需求”子节。
用法
广泛使用示例，并在可能的情况下展示预期的输出。如果你能展示最小的使用示例，将非常有帮助，同时提供指向更复杂示例的链接，如果它们太长而不适合合理包含在README中。
支持
告诉人们他们可以到哪里寻求帮助。可以是任何组合的问题跟踪器、聊天室、电子邮件地址等。
路线图
如果你对未来发布有想法，将其列入README是个好主意。
贡献
说明你是否接受贡献以及接受贡献的要求。
对于想要修改你的项目的人来说，提供一些如何开始的文档是有帮助的。也许有一些他们应该运行的脚本或他们需要设置的某些环境变量。明确这些步骤。这些说明对你的未来自我也可能有用。
你也可以记录检查代码或运行测试的命令。这些步骤有助于确保代码质量高，并减少无意中破坏某物的可能性。如果运行测试需要外部设置，例如启动Selenium服务器进行浏览器测试，那么运行测试的说明将特别有用。
作者和致谢
感谢那些为项目做出贡献的人。
许可证
对于开源项目，说明其许可证。
项目状态
如果你已经没有精力或时间继续你的项目，请在README顶部注明开发已放缓或已完全停止。有人可能会选择分叉你的项目或志愿成为维护者或所有者，让你的项目继续进行。你也可以明确要求维护者。