README

目录

1. 安装
2. 使用
3. 版本控制
4. 贡献
5. 黑客
6. 许可协议

1. 安装

本版本的包需要 Symfony 6.0+ 和 PHP 8.1+。此外，请确保正确配置lexik/maintenance-bundle。

1.1 Composer

composer require rich-id/maintenance-bundle

1.2 包声明

安装后，请确保在 Kernel 的包列表中正确声明了包。如果你使用 Symfony Flex，这将自动完成。

return [
    // ...
   Lexik\Bundle\MaintenanceBundle\LexikMaintenanceBundle::class => ['all' => true],
   RichId\MaintenanceBundle\Infrastructure\RichIdMaintenanceBundle::class => ['all' => true],
];

1.3 必要配置

rich_id_maintenance:
    resource: "@RichIdMaintenanceBundle/Resources/config/routing/routing.xml"

你还必须配置lexik/maintenance-bundle。请查阅Lexik 维护包文档。

2. 使用

该包生成一个后台页面，通过 ROLE_MAINTENANCE_ADMIN 角色在 /administration/maintenance URL 上可访问。

你还可以在网站上集成一个标志，在网站处于维护状态且用户在授权 IP 地址列表中时显示。这允许授权用户在维护期间仍然使用网站，但提醒没有人可以访问。

{% include '@RichIdMaintenance/flag/main.html.twig' %}

3. 版本控制

tour-bundle 遵循语义版本控制。简而言之，该方案是 MAJOR.MINOR.PATCH，其中

1. MAJOR 在出现重大更改时增加，
2. MINOR 在向后兼容的方式中添加新功能时增加，
3. PATCH 在向后兼容的方式中修复错误时增加。

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

4. 贡献

欢迎贡献！有很多方式可以做出贡献，我们非常感激。以下是一些主要的贡献方式：

• 错误报告：虽然我们努力追求高质量软件，但错误可能会发生，我们无法修复我们不知道的问题。所以请即使你不确定或者只是想提问也请报告。事实上，问题可能表明文档还可以进一步改进！
• 功能请求：你的用例当前 API 没有涵盖？想要建议一个更改或添加一些内容？我们很高兴看到它并开始讨论以尝试找到最佳解决方案。
• 拉取请求：想要贡献代码或文档？我们非常乐意！如果你需要帮助开始，GitHub 有关于拉取请求的文档。我们使用“fork and pull”模型，其中贡献者将更改推送到他们个人的分叉，然后创建对主存储库的拉取请求。请将你的拉取请求针对 master 分支。

提醒大家，所有贡献者都应遵守我们的行为准则。

5. 破坏性测试

您可以使用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

6. 许可证

maintenance-bundle是在MIT许可证的条款下分发的。

有关详细信息，请参阅LICENSE。