README

一个模块，用于快速实现带有条款版本支持的条款审批投票器。

1. 安装

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

composer require rich-id/terms-module-bundle

您必须通过向文件 config/routes/rich_id_terms_module.yaml 中添加以下内容来将路由添加到您的应用程序：

rich_id_terms_module:
    resource: "@RichIdTermsModuleBundle/Resources/config/routing/routing.xml"

# # Edit the path of the routes
# module_terms_sign:
#     path: /cgu/{termsSlug}/signature
#     methods: [GET|POST]
#     defaults: { _controller: RichId\TermsModuleBundle\UserInterface\Controller\SignRoute }
#
# module_terms_terms:
#     path: /cgu/{termsSlug}
#     methods: GET
#     defaults: { _controller: RichId\TermsModuleBundle\UserInterface\Controller\TermsRoute }

2. 文档

3. 版本控制

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

低于 1.0.0 的版本被视为实验性的，并且在任何时候都可能发生重大更改。

4. 贡献

欢迎贡献！有许多贡献方式，我们感激所有贡献。以下是一些主要的贡献方式

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

提醒一下，所有贡献者都应遵守我们的 [行为准则](CODE_OF_CONDUCT.md)。

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

rich-id / terms-module-bundle

维护者

详细信息