paysera / skeleton-lib
基于GitHub的新库骨架
1.0.0
2018-12-18 20:04 UTC
Requires
- php: >=7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: 2.11.1
- mockery/mockery: ^1.2
- paysera/lib-php-cs-fixer-config: ^2.0
- phpunit/phpunit: ^6.5
This package is auto-updated.
Last update: 2024-09-25 20:32:28 UTC
README
这是一个基于GitHub的PHP库的骨架。
以下步骤
- 修改
composer.json
文件- 修改
name
和description
字段; - 修改命名空间;
- 如果它是Symfony包,则将
type
从library
更改为symfony-bundle
; - 添加关键词;
- 添加任何额外的需求;
- 修改
- 如有必要,更改
LICENCE
中的年份(和/或作者); - 更新本说明;
- 将所有
:vendor/:package_name
出现的位置替换为您的库的供应商和名称; - 阅读并替换readme中的TODOs;
- 将所有
- 在
src
目录中更改/添加文件,不要忘记修改命名空间; - 在
tests
目录中更改/添加测试用例,不要忘记修改命名空间; - 提交初始提交后,将库添加到Packagist、Travis和Scrutinizer。
每次发布
- 您可以使用
composer fix-cs
修复代码样式; - 您可以使用
composer test
运行测试和代码样式检查; - 不要忘记更新
CHANGELOG.md
。
要使用此骨架开始库
composer create-project paysera/skeleton-lib directory-name
以下readme只是您新库的结构,与骨架本身无关。
🔴 TODO: 使用关于库的描述更改此部分和标题。
为什么?
🔴 TODO: 解释开发人员何时以及为什么应该使用此库 - 它的主要目的和/或与其他解决方案的区别。
您也可以将其重命名为## 特点
或其他类似的目的标题。
如果目的已经在主要描述中明确,请删除此部分。
安装
composer require :vendor/:package_name
配置
🔴 TODO: 解释包配置或删除此部分以非包库。
paysera_something: field: value
用法
🔴 TODO: 解释如何使用此库。使用代码示例以获得更好的理解。
语义版本化
此库遵循语义版本化。
有关API中可以更改的内容以及不能更改的内容的基本信息,请参阅Symfony BC规则。
🔴 TODO: 删除此部分的以下部分或使用之前的部分。删除无关项,如twig函数,如果它们不是由您的库提供的。
此包遵循语义版本化。
此包的公共API(换句话说,如果您想轻松更新到新版本,则应仅使用这些功能)
- 仅标记为
public="false"
的服务 - 标记有
@api
的类、接口和类方法 - twig函数和标签
- 控制台命令
- 支持的DIC标签
例如,如果只有类方法标记有@api
,则不应扩展该类,因为构造函数可以在任何版本中更改。
请参阅Symfony BC 规则以获取有关API中可以更改和不能更改的基本信息。请注意,在此包中,默认情况下所有内容都是@internal
。
运行测试
composer update
composer test
贡献
欢迎创建问题和提交拉取请求。
您可以使用此命令修复任何代码风格问题
composer fix-cs