rich-id/design-customization-bundle

设计定制包

v0.4.0 2024-06-03 12:38 UTC

README

design customization bundle badge badge maintainability contributions welcome brightgreen license MIT blue PHP 8 Symfony 5

一个用于快速管理网站图形元素的模块。

目录

1. 安装

此版本的包需要Symfony 6.0+ 和 PHP 8.1+。

composer require rich-id/design-customization-bundle

2. 文档

2.1. 配置

2.2. 创建

2.3. Twig扩展

2.4. Twig工具类

3. 版本控制

design-customization-bundle遵循语义版本控制。简而言之,方案是MAJOR.MINOR.PATCH,其中1. MAJOR在发生重大更改时增加,1. MINOR在以向后兼容的方式添加新功能时增加,1. PATCH在以向后兼容的方式修复错误时增加。

低于1.0.0的版本被视为实验性版本,任何时间都可能发生重大更改。

4. 贡献

欢迎贡献!有许多贡献方式,我们都很感激。以下是一些主要方式:

  • 错误报告:虽然我们努力提供高质量的软件,但错误可能发生,我们无法修复我们不知道的问题。因此,即使您不确定或者只是想提问,也请报告。实际上,问题可能表明文档还可以改进!

  • 功能请求:您有一个当前API没有涵盖的使用案例吗?想要建议更改或添加某些内容吗?我们很高兴看到它,并开始讨论以尝试找到最佳解决方案。

  • 拉取请求:想要贡献代码或文档吗?我们很乐意这样做!如果您需要帮助开始,GitHub上有关于拉取请求的文档。我们使用"fork and pull model",即贡献者将更改推送到他们的个人fork,然后创建拉取请求到主存储库。请确保您的拉取请求针对master分支。

提醒一下,所有贡献者都应遵守我们的行为准则

5. 许可证

测试套件在MIT许可证下分发。

有关详细信息,请参阅LICENSE

6. 开发

您可能可以使用Docker和docker-compose来开发项目。请查看以下命令。

# Start the project
docker-compose up -d

# Install dependencies
docker-compose exec application composer install

# Run tests
docker-compose exec application bin/phpunit

# Run a bash within the container
docker-compose exec application bash