chaplean/slack-client-bundle

The Bundle base to fork

dev-master 2018-11-27 16:36 UTC

This package is not auto-updated.

Last update: 2022-06-11 15:43:01 UTC


README

build status build status contributions welcome

This bundle allows you to use the slack api easily from your php code.

Table of content

Installation

This bundle requires at least Symfony 3.0.

You can use composer to install slack-client-bundle:

composer require chaplean/slack-client-bundle

Then add to your AppKernel.php:

new Chaplean\Bundle\SlackClientBundle\ChapleanSlackClientBundle(),

Configuration

First you will need to import the bundle configuration.

config.yml:

imports:
    - { resource: '@ChapleanSlackClientBundle/Resources/config/config.yml' }

You must also create some parameters.

parameters.yml:

parameters:
    chaplean_slack_client.access_token: 'your access token'

Usage

See the rest-client-bundle's usage documentation.

Available functions:

Note: Slack uses the POST method for all api endpoints.

Versioning

slack-client-bundle follows semantic versioning. In short the scheme is MAJOR.MINOR.PATCH where

  1. MAJOR is bumped when there is a breaking change,
  2. MINOR is bumped when a new feature is added in a backward-compatible way,
  3. PATCH is bumped when a bug is fixed in a backward-compatible way.

Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.

Contributing

Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:

  • Bug Reports: While we strive for quality software, bugs can happen and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!
  • Feature Request: You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.
  • Pull Request: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as documentation on pull requests. We use the "fork and pull model" were contributors push changes to their personnal fork and then create pull requests to the main repository. Please make your pull requests against the master branch.

As a reminder, all contributors are expected to follow our Code of Conduct.

Hacking

You might find the following commands usefull when hacking on this project:

# Install dependencies
composer install

# Run tests
bin/phpunit

License

slack-client-bundle is distributed under the terms of the MIT license.

See LICENSE for details.