richcongress/test-tools

该库提供了一套用于通过单元测试测试您的应用程序的工具。

v0.2.0 2024-06-03 09:48 UTC

This package is auto-updated.

Last update: 2024-09-03 10:18:15 UTC


README

本版套件需要 PHP 8.1+。

Package version Actions Status Coverage Status Maintainability contributions welcome License PHP

快速开始

快速展示

目录

  1. 安装
  2. 入门
  3. 版本控制
  4. 贡献
  5. 开发
  6. 许可证

1. 安装

本版套件需要 PHP 8.1+。

composer require richcongress/test-tools

2 入门

待办事项 ;)

3. 版本控制

test-tools遵循语义版本控制。简而言之,方案是 MAJOR.MINOR.PATCH,其中

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

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

4. 贡献

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

  • 错误报告:虽然我们努力提供高质量的软件,但错误可能会发生,我们无法修复我们不了解的问题。所以请报告,即使您不确定或者只是想提问。事实上,问题可能表明文档还可以进一步改进!
  • 功能请求:当前API没有覆盖您的用例?希望提出建议或添加某些内容?我们将很高兴阅读并开始讨论以找到最佳解决方案。
  • 拉取请求:希望贡献代码或文档?我们非常愿意!如果您需要帮助开始,GitHub有关于拉取请求的文档。我们使用“fork and pull模型”,其中贡献者将更改推送到他们的个人fork,然后创建拉取请求到主仓库。请将您的拉取请求针对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. 许可证

test-tools在MIT许可证的条款下分发。

有关详细信息,请参阅LICENSE