brightnucleus/contracts

# Bright Nucleus Contracts Component

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/brightnucleus/contracts/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/brightnucleus/contracts/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/brightnucleus/contracts/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/brightnucleus/contracts/?branch=master)
[![Build Status](https://scrutinizer-ci.com/g/brightnucleus/contracts/badges/build.png?b=master)](https://scrutinizer-ci.com/g/brightnucleus/contracts/build-status/master)
[![Codacy Badge](https://api.codacy.com/project/badge/grade/1122bafb0b3940f58430979497eaec11)](https://www.codacy.com/app/BrightNucleus/contracts)
[![Code Climate](https://codeclimate.com/github/brightnucleus/contracts/badges/gpa.svg)](https://codeclimate.com/github/brightnucleus/contracts)

[![Latest Stable Version](https://poser.pugx.org/brightnucleus/contracts/v/stable)](https://packagist.org/packages/brightnucleus/contracts)
[![Total Downloads](https://poser.pugx.org/brightnucleus/contracts/downloads)](https://packagist.org/packages/brightnucleus/contracts)
[![Latest Unstable Version](https://poser.pugx.org/brightnucleus/contracts/v/unstable)](https://packagist.org/packages/brightnucleus/contracts)
[![License](https://poser.pugx.org/brightnucleus/contracts/license)](https://packagist.org/packages/brightnucleus/contracts)

Set of segregated interfaces that are reused across different Bright Nucleus components.

## Installation

The best way to use this component is through Composer:

```BASH
composer require brightnucleus/contracts
```

## Usage

> TODO

## Contributing

All feedback / bug reports / pull requests are welcome.

Please use the provided `pre-commit` hook. To install it, run the following command from the project's root:
```BASH
ln -s ../../.pre-commit .git/hooks/pre-commit
```