README

入门

为了使您能够轻松开始使用GitLab，以下是一份推荐下一步操作的列表。

已经是专业人士？只需编辑此README.md并使其成为您自己的。想要让它变得简单？使用底部的模板！

添加您的文件

[ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或上传文件
[ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?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/Bookimed/doctors-client.git
git branch -M main
git push -uf origin main

集成您的工具

[ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/user/project/integrations/)

与您的团队协作

[ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [自动关闭合并请求中的问题](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [在管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?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:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用安全测试（SAST）分析您的代码以识别已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/user/application_security/sast/)
[ ] [使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
[ ] [使用基于拉的部署来提高Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:8f7b56353911f87238391159dad944ec?https://docs.gitlab.com/ee/user/clusters/agent/)

编辑此README

当您准备好将此README作为自己的内容时，只需编辑此文件并使用下面的便捷模板（或者您可以随意构建它 - 这只是一个起点！）感谢makeareadme.com提供此模板。

优秀的README建议

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

名称

为您的项目选择一个易于解释的名称。

描述

让人们知道您的项目具体能做什么。提供上下文并添加链接，以便访问者了解任何不熟悉的参考。在此处还可以添加功能列表或背景子部分。如果您的项目有替代品，这是列出不同点的良好位置。

徽章

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

视觉效果

根据您正在制作的内容，包括截图甚至视频（您通常会看到GIF而不是实际视频）可能是一个好主意。例如，ttygif等工具可以帮助，但请检查Asciinema以获得更复杂的方法。

安装

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

用法

广泛使用示例，并在可能的情况下显示预期的输出。如果您可以演示最小的使用示例，这会很有帮助，同时提供链接到更复杂的示例，如果它们太长而无法合理包含在README中。

支持

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

路线图

如果您对未来发布有想法，将其列在README中是一个好主意。

贡献

说明您是否欢迎贡献以及接受贡献的要求。

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

您还可以记录检查代码或运行测试的命令。这些步骤有助于确保代码质量高，并降低更改意外破坏事物的可能性。如果需要外部设置，如启动Selenium服务器进行浏览器测试，运行测试的说明尤其有用。

作者和致谢

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

许可

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

项目状态

如果您项目的能量或时间已经耗尽，请在README文件顶部添加一条备注，说明开发已放缓或完全停止。有人可能会选择分支您的项目或自愿担任维护者或所有者，使您的项目继续进行。您还可以明确请求维护者。

bookimed / doctors-client

维护者

详细信息