Orchard Db Library
==================

This Orchard library provides commonly used functionality related to PDO and database usage. It was ported over from [`common repo`](github.com/theorchard/common)

## Getting Started

### Installation

```bash
composer require orchard/db
```

### Testing

Ensure ant is installed and available on your path.

```bash
cd build/
ant phpunit
```

or

```bash
vendor/bin/phpunit tests/
```

### Linting
Ensure ant is installed and available on your path.

```bash
cd build
ant phpcs
```

or

```bash
vendor/bin/phpcs -p --standard=PSR2 src/
vendor/bin/phpcs -p --standard=PSR2 tests/
```

### Releasing Versions

To release a new version of your library, create an atomic PR, consisting of one change to the composer.json file:

```json
"version": "NEW_VERSION_HERE"
```

Then, run a comparison between the last stable tag to master using this URL - `https://github.com/theorchard/php-orchard-db/compare/{source_tag}...master`. All you need to change is the `{source_tag}`.

Please copy all commit messages from the comparison result and convert that into the release notes for the new version. Please use bullet points for each note.

Once you have the release notes, put them in the description field of the PR and send it for review. Upon approval and merge, create a new tag using Github.