通过 
搜索
搜索tfarla / composer-template
用于创建 composer 库的模板
0.1.1
2018-04-02 08:27 UTC
Requires
- php: ~7.1
Requires (Dev)
- johnkary/phpunit-speedtrap: ^3.0
- php-coveralls/php-coveralls: ^2.0
- phpmd/phpmd: ^2.6
- phpstan/phpstan: ^0.9.2
- phpunit/phpunit: ^7.0
- squizlabs/php_codesniffer: ^3.2
This package is auto-updated.
Last update: 2024-09-08 04:33:35 UTC
README
使用此可克隆模板简化 composer 库的开发，它包括
- 持续集成 (travis ci)
- 代码覆盖率 (coveralls)
- 静态分析 (phpstan)
- 代码质量检测器 (phpmd)
- 测试框架 (phpunit)
- php 代码规范检查器，强制执行 psr-2 标准 (phpcs)
- 使用 psr-4 自动加载 的 composer 配置
- 变更日志
- MIT 许可证（不确定需要哪种许可证？ https://choosealicense.com/)
- 使用 sphinx 创建文档
- 问题和拉取请求模板
- 来自 https://shieldsio.npmjs.net.cn/ 的徽章
要求
- php 7.1 或更高版本 (支持版本)
- python 和 pip 以创建文档
- composer
安装
以下命令将克隆此模板并将其放置在 my-library 目录中
composer create-project tfarla/composer-template my-library
Composer 的 create-project 命令还将安装模板中的所有依赖
Installing tfarla/composer-template (dev-master d3249c7ffef021c39e33a4323be4d70899d4d28b)
- Installing tfarla/composer-template (dev-master master): Cloning master from cache
Created project in my-library
Loading composer repositories with package information
Installing dependencies (including require-dev) from lock file
Generating autoload files
ocramius/package-versions: Generating version class...
ocramius/package-versions: ...done generating version class
下载完成后，您将可以选择删除 .git 目录，如果您想拥有自己的仓库，则应该这么做。
Do you want to remove the existing VCS (.git, .svn..) history? [Y,n]? y
用法
为了使用此模板，您需要更改一些内容
- 更改此 README 文件中的内容以反映您的库
- 更改
docs/目录中的内容以反映您的库 - 设置 travis-ci（应该是即插即用）
- 设置 readthedocs（应该是即插即用）
- 设置 coveralls（应该是即插即用）
- 选择许可证 https://choosealicense.com/（MIT 对于大多数开源项目来说已经足够好，但您可能想查看其他选项）
文档
虽然这个 README 已经足够开始使用，但请阅读完整文档以获取更多详细信息。
贡献
感谢您阅读到这份 README 的最后，并考虑为此项目做出贡献。如果您有任何问题或建议，请随时创建一个问题。
如果您想修改代码，请按照以下步骤操作
- 将其分叉 (https://github.com/TFarla/composer-template)
- 创建您的功能分支 (git checkout -b feature/fooBar)
- 提交您的更改（git commit -am '添加一些fooBar'）
- 推送到分支（git push origin feature/fooBar）
- 创建一个新的Pull Request