fdt2k / laravel-models
模型特性集合
Requires
- fdt2k/laravel-package-service-provider: dev-master || dev-master-2 || 1 - 2
README
laravel的模型特性
入门
为了帮助您快速开始使用GitLab,以下是一些推荐的操作步骤。
已经是专家?只需编辑此README.md,使其成为您自己的。想要更简单?使用下面的模板!
添加您的文件
- [ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或 上传 文件
- [ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?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-models.git
git branch -M main
git push -uf origin main
集成您的工具
与您的团队协作
- [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/members/)
- [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [从合并请求自动关闭问题](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [启用合并请求批准](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?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:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [使用静态应用安全测试(SAST)分析代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [使用基于拉取的部署来改进Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:15c22ca4bf17b73aa38583a0910fd41c?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文件顶部,说明开发已经放缓或完全停止。有人可能会选择分叉您的项目,或自愿担任维护者或所有者,让项目继续进行。您还可以明确提出对维护者的请求。