搜索sikessem / php-util
Requires
- php: >=8.0
This package is auto-updated.
Last update: 2024-09-22 16:06:40 UTC
README
PHP框架，为网站管理员设计
入门指南
为了帮助您在GitLab中快速开始，以下是一些推荐的下一步操作。
已经是专业人士？只需编辑此README.md并将其变成您自己的。想要简化？请使用下面的模板！
添加您的文件
- [ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或 上传 文件
- [ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?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/PHPUtil/phputil.git
git branch -M main
git push -uf origin main
与您的工具集成
与您的团队协作
- [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/members/)
- [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [自动关闭合并请求中的问题](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [启用合并请求审批](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [在管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?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:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [使用静态应用安全测试(SAST)分析您的代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [使用自动部署部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [使用基于拉取的部署以改进Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:0a673a1c5d509679bef90572594e377d?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的顶部添加一条说明，表明开发已经放缓或完全停止。有人可能会选择分支您的项目或志愿担任维护者或所有者，使您的项目得以继续。您还可以明确提出对维护者的请求。