fdt2k / laravel-guest-to-member
Requires
- php: ^7.3|^8.0
- fdt2k/laravel-package-service-provider: dev-dev-v2 ||^2.0
Requires (Dev)
- laravel-shift/blueprint: dev-master
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.com/karsegard/laravel-guest-to-member.git
git branch -M main
git push -uf origin main
与您的工具集成
与您的团队协作
- [ ] [邀请团队成员和协作者](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的顶部注明开发已放缓或完全停止。有人可能会选择fork您的项目或志愿担任维护者或所有者,从而使您的项目继续进行。您也可以明确请求维护者。