rich-id/email-template-bundle

电子邮件模板包

v0.2.4 2024-08-28 14:37 UTC

README

email template 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/email-template-bundle

2. 文档

3. 版本控制

email-template-bundle 遵循 语义化版本控制。简而言之,版本号结构为 MAJOR.MINOR.PATCH,其中 1. MAJOR 在出现重大变更时增加,1. MINOR 在以向后兼容的方式添加新功能时增加,1. PATCH 在以向后兼容的方式修复错误时增加。

1.0.0 版本以下的版本被视为实验性版本,可能随时出现破坏性变更。

4. 贡献

欢迎贡献!有多种贡献方式,我们非常感激。以下是一些主要的贡献方式

  • 错误报告:虽然我们力求软件质量,但错误仍可能发生,我们无法修复我们不知道的问题。因此,即使您不确定或只是想提出问题,也请报告。无论如何,问题可能表明文档仍有改进的空间!

  • 功能请求:当前 API 没有涵盖您的用例?希望提出建议或添加某些内容?我们非常乐意了解并开始讨论,以尝试找到最佳解决方案。

  • 拉取请求:希望贡献代码或文档?我们非常欢迎!如果您需要帮助开始,GitHub 提供了有关 拉取请求 的文档。我们使用 "fork and pull model",即贡献者将更改推送到他们的个人分支,然后创建拉取请求到主存储库。请确保您的拉取请求针对 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