rich-id/mailer-bundle

Mailer bundle

v0.6.0 2024-08-28 14:48 UTC

README

mailer 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/mailer-bundle

2. 文档

3. 版本控制

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

1.0.0 以下的版本被视为实验性版本,并且可能随时发生重大变更。

4. 贡献

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

  • 错误报告:我们力求提供高质量的软件,但错误仍可能发生。因此,即使您不确定或者只是想提问,也请报告问题。任何可能的问题都可能表明文档仍需改进!

  • 功能请求:当前的 API 没有涵盖您的用例吗?想要建议更改或添加内容?我们将非常乐意阅读并开始讨论,以寻找最佳解决方案。

  • 拉取请求:想贡献代码或文档?我们非常欢迎!如果您需要帮助开始,GitHub 有关于拉取请求的 文档。我们使用 “分支合并模型”,即贡献者将更改推送到他们的个人分支,然后创建拉取请求到主仓库。请将您的拉取请求针对 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