chaplean/kanbanize-client-bundle

Kanbanize Api客户端

v1.1.0 2019-06-06 13:22 UTC

This package is auto-updated.

Last update: 2024-09-07 01:48:23 UTC


README

contributions welcome Coverage Status

目录

安装

您可以使用composer安装此软件

composer require chaplean/kanbanize-api-client-bundle

配置

在您的parameters.yml中定义参数

chaplean_kanbanize_api.apikey: 'your apikey' # A default apikey of an kanbanize user
chaplean_kanbanize_api_v1.url: 'kanbanize url api v1' # Probably: https://<your team>.kanbanize.com/index.php/api/kanbanize/
chaplean_kanbanize_api_v2.url: 'kanbanize url api v2' # Probably: https://<your team>.kanbanize.com/api/v2/

使用

您可以使用API的2个版本。

版本1: KanbanizeApiV1(见:https://kanbanize.com/api

可用路由

版本2(beta):KanbanizeApiV2(见:https://<your team>.kanbanize.com/openapi/#/)

可用功能

版本控制

kanbanize-api-client-bundle遵循语义化版本控制。简而言之,方案是MAJOR.MINOR.PATCH,其中

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

低于1.0.0的版本被认为是实验性的,并且在任何时候都可能发生重大变更。

贡献

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

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

提醒一下,所有贡献者都应遵守我们的行为准则

开发

您可能会发现以下命令在开发此项目时很有用

# Install dependencies
composer install

# Run tests
bin/phpunit

许可协议

kanbanize-api-client-bundle是在MIT许可协议下分发的。

有关详细信息,请参阅LICENSE