README

UF4 - 实践

入门

为了帮助您快速开始使用GitLab，以下是一份推荐步骤列表。

已经是专家了吗？只需编辑此README.md，使其成为您自己的。想让它变得简单？使用下面的模板！

添加您的文件

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

与您的工具集成

• [ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?https://gitlab.com/josemariacuadrado0/jmc-dam/-/settings/integrations)

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [合并请求自动关闭问题](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [启用合并请求审批](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
• [ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?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:470f5caece924cdb03cf68bf2fd50095?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用安全测试(SAST)分析代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?https://docs.gitlab.com/ee/user/application_security/sast/)
• [ ] [使用自动部署将应用部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
• [ ] [使用基于拉的部署以改进Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?https://docs.gitlab.com/ee/user/clusters/agent/)
• [ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:470f5caece924cdb03cf68bf2fd50095?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文件顶部注明项目开发已放缓或完全停止。有人可能会选择分支您的项目或自愿担任维护者或所有者，从而使您的项目继续进行。您还可以明确请求维护者。