README

入门

为了帮助您在GitLab中快速开始，以下是一系列推荐步骤。

已经是老手？只需编辑此README.md并使其成为您的个人版本。想要更容易？使用底部的模板！

添加您的文件

[ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或上传文件
[ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) 或使用以下命令推送现有的Git仓库

cd existing_repo
git remote add origin https://gitlab.com/fdt2k/backpack-breadcrumb.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://gitlab.com/fdt2k/backpack-breadcrumb/-/settings/integrations)

与您的团队协作

[ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [自动关闭合并请求中的问题](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [启用合并请求批准](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
[ ] [当管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用GitLab内置的持续集成。

[ ] [开始使用GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用安全测试(SAST)分析代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/user/application_security/sast/)
[ ] [使用自动部署将应用部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
[ ] [使用基于拉的部署以改善Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/user/clusters/agent/)
[ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:ccfc77eb57382472780b9cdf655f1969?https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

编辑此README

当你准备好使此README成为你自己的，只需编辑此文件并使用下面的便捷模板（或者你也可以自由地按照你想要的结构来组织它——这只是一个起点！）感谢makeareadme.com提供此模板。

好的README的建议

每个项目都是不同的，所以考虑哪些部分适用于你的项目。模板中使用的部分是大多数开源项目的建议。同时，请注意，虽然README可能太长或太详细，但太长总比太短好。如果你认为你的README太长，考虑使用另一种形式的文档，而不是删除信息。

名称

为你的项目选择一个自解释的名称。

描述

让人们知道你的项目能做什么。提供上下文，并添加任何参考链接，以便访问者可能不熟悉。也可以在这里添加功能列表或背景子部分。如果你的项目有替代方案，这是一个列出不同因素的好地方。

徽章

在某些README中，你可能会看到传达元数据的小图像，例如项目是否所有测试都通过。你可以在README中添加一些徽章。许多服务也提供了添加徽章的说明。

视觉内容

根据你正在制作的内容，包括截图甚至视频（你通常会看到GIF而不是实际视频）是一个好主意。像ttygif这样的工具可以帮助，但请查看Asciinema以获得更高级的方法。

安装

在特定的生态系统内，可能存在一种常见的安装方式，例如使用Yarn、NuGet或Homebrew。然而，考虑到阅读你的README的人可能是一个新手，并希望获得更多指导。列出具体的步骤有助于消除歧义，并尽快让人们使用你的项目。如果它只在特定上下文中运行，如特定编程语言版本或操作系统，或者有必须手动安装的依赖项，也请添加一个要求子部分。

用法

自由使用示例，并在可能的情况下显示预期输出。如果有太长的示例无法合理地包含在README中，提供链接到更复杂的示例也很有帮助。

支持

告诉人们他们可以到哪里寻求帮助。可以是任何组合的问题跟踪器、聊天室、电子邮件地址等。

路线图

如果你对未来的发布有任何想法，将它们列在README中是一个好主意。

贡献

说明你是否接受贡献以及接受它们的要求。

对于想要修改你的项目的人来说，有一些如何开始的文档是有帮助的。也许有一个他们应该运行的脚本或一些他们需要设置的环境变量。明确这些步骤。这些说明也可能对你未来的自己有用。

您还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并降低更改意外破坏某些内容的风险。如果需要外部设置，例如在浏览器中测试时启动Selenium服务器，那么提供运行测试的说明尤其有帮助。

作者和致谢

向为项目做出贡献的人表示感谢。

许可证

对于开源项目，说明其许可证。

项目状态

如果您在项目上耗尽了精力或时间，请在README的顶部注明开发已放缓或完全停止。有人可能会选择分叉您的项目或志愿成为维护者或所有者，使您的项目继续进行。您还可以明确请求维护者。

fdt2k/ backpack-breadcrumbs

维护者

详情