README

入门指南

为了使您更容易开始使用 GitLab，以下是一些推荐的下一步操作。

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

添加您的文件

[ ] [创建](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或上传文件
[ ] [使用命令行添加文件](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.wpdesk.dev/wpdesk/library/wp-mail.git
git branch -M main
git push -uf origin main

集成您的工具

[ ] [设置项目集成](https://gitlab.wpdesk.dev/wpdesk/library/wp-mail/-/settings/integrations)

与您的团队协作

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

测试和部署

使用 GitLab 内置的持续集成。

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

编辑此 README

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

良好的 README 建议

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

名称

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

描述

让人们知道您的项目具体能做什么。提供上下文，并添加链接到任何可能使访问者不熟悉的参考信息。也可以在此处添加功能列表或背景子部分。如果您的项目有替代方案，这也是列出不同之处的好地方。

徽章

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

视觉元素

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

安装

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

使用

自由地使用示例，并在可能的情况下显示预期输出。如果能将您能展示的最小使用示例放在行内，同时提供链接到更复杂的示例（如果它们太长而无法合理地包含在README中），那就很有帮助。

支持

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

路线图

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

贡献

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

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

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

作者和致谢

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

许可证

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

项目状态

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

wpdesk / wp-mail

维护者

详细信息