README

PHP 的表单验证

入门

为了帮助您轻松开始使用 GitLab，以下是一些推荐的下一步操作。

已经是老手了？只需编辑此 README.md，使其成为您的个人版本。想要让它变得简单？ 使用下面的模板！

添加您的文件

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

集成您的工具

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

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:eb591c7281436b353780d0c0e00c3726?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:eb591c7281436b353780d0c0e00c3726?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [自动关闭来自合并请求的问题](https://gitlab.com/-/experiment/new_project_readme_content:eb591c7281436b353780d0c0e00c3726?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [当管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:eb591c7281436b353780d0c0e00c3726?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:eb591c7281436b353780d0c0e00c3726?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用程序安全测试(SAST)分析您的代码中已知的漏洞](https://gitlab.com/-/experiment/new_project_readme_content:eb591c7281436b353780d0c0e00c3726?https://docs.gitlab.com/ee/user/application_security/sast/)

编辑此 README

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

良好的 README 的建议

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

名称

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

描述

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

徽章

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

视觉

根据您正在制作的内容，包含截图甚至视频（您通常会发现GIF而不是实际视频）是个好主意。像ttygif这样的工具可以有所帮助，但请查看Asciinema以获取更复杂的方法。

安装

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

使用

自由使用示例，并尽可能展示预期输出。如果有太多示例无法合理包含在README中，提供链接到更复杂的示例也很 helpful。

支持

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

路线图

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

贡献

说明您是否愿意接受贡献以及接受贡献的要求。

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

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

作者和致谢

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

许可证

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

项目状态

如果您已经耗尽了为项目提供能量或时间，请将一条备注放在README的顶部，说明开发已放缓或完全停止。有人可能会选择分叉您的项目或自愿担任维护者或所有者，让您的项目继续前进。您还可以明确提出维护者的请求。