bytecity / tylersoft
Stencil Technologies 集成支付的打包程序
Requires
- guzzlehttp/guzzle: ~6.0||~7.0
README
入门
为了使您在 GitLab 上的入门更加容易,以下是推荐的下步操作列表。
已经是专家?只需编辑此 README.md 并使其成为您的专属。想让它变得容易?使用下面的模板!
添加您的文件
- [ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或 上传 文件
- [ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?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/bytecity/taylersoft-php-laravel-package.git
git branch -M main
git push -uf origin main
集成您的工具
与您的团队协作
- [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?https://docs.gitlab.com/ee/user/project/members/)
- [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [合并请求自动关闭问题](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?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:381664f2537a6e45d50735b896dbb587?https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [使用静态应用安全测试(SAST)分析代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [使用自动部署部署到 Kubernetes、Amazon EC2 或 Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [使用基于拉的部署来提高Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:381664f2537a6e45d50735b896dbb587?https://docs.gitlab.com/ee/user/clusters/agent/)
编辑此README
当你准备好将此README变成你自己的时,只需编辑此文件并使用下面的便捷模板(或者你可以自由地按照你想要的任何方式结构化它——这只是一个起点!)感谢makeareadme.com提供此模板。
优秀README的建议
每个项目都是不同的,所以考虑这些部分中哪些适用于你的项目。模板中使用的部分是大多数开源项目的建议。同时也要记住,虽然README可能太长太详细,但太长总比太短好。如果你认为你的README太长,考虑使用其他形式的文档,而不是删除信息。
名称
为你的项目选择一个自解释的名称。
描述
让人们知道你的项目具体能做什么。提供上下文并添加任何可能对访问者不熟悉的参考链接。也可以在这里添加功能列表或背景子部分。如果你的项目有替代品,这是一个列出不同点的良好位置。
徽章
在某些README中,你可能看到一些小图像,用于传达元数据,例如项目是否所有测试都通过。你可以在README中添加一些徽章。许多服务也提供了添加徽章的说明。
视觉内容
根据你正在制作的内容,包括截图甚至视频(你通常会看到GIF而不是实际视频)可能是个好主意。ttygif等工具可以帮助,但请查看Asciinema以获取更高级的方法。
安装
在特定的生态系统内,可能存在一种常见的安装方式,例如使用Yarn、NuGet或Homebrew。但是,请考虑阅读你的README的人可能是一位新手,并希望获得更多指导。列出具体步骤有助于消除歧义,并尽可能快地让人们使用你的项目。如果它仅在特定的上下文中运行,如特定的编程语言版本或操作系统,或者有需要手动安装的依赖项,也可以添加一个要求子部分。
使用
自由地使用示例,并在可能的情况下展示预期输出。如果你能提供尽可能小的使用示例,同时提供指向更复杂示例的链接(如果它们太长而无法合理地包含在README中),这将很有帮助。
支持
告诉人们他们可以去哪里寻求帮助。可以是任何组合的问题跟踪器、聊天室、电子邮件地址等。
路线图
如果你对未来版本有想法,将其列在README中是个好主意。
贡献
声明你是否接受贡献以及接受它们的要求。
对于想要修改你的项目的人来说,有一些关于如何开始的文档会很有帮助。也许有一些他们应该运行的脚本,或者一些他们需要设置的环境变量。明确这些步骤。这些说明对你的未来自己也可能很有用。
你还可以记录代码检查或运行测试的命令。这些步骤有助于确保代码质量高,并降低更改意外破坏事物的可能性。如果运行测试需要外部设置,例如在浏览器中测试需要启动Selenium服务器,运行测试的说明尤其有帮助。
作者和致谢
向为项目做出贡献的人表示感谢。
许可协议
对于开源项目,说明其许可方式。
项目状态
如果你已经耗尽了为项目投入的精力和时间,请在README文件顶部注明项目开发已放缓或已完全停止。有人可能会选择分支你的项目或自愿担任维护者或所有者,以使你的项目继续进行。你还可以明确请求维护者。