Contributing to PHP-Nominatim
=======================

Looking to contribute something to this library? Here's how you can help.

## Bugs

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful – thank you!

Please try to be as detailed as possible in your report. Include specific information about the environment – version of PHP, etc, and steps required to reproduce the issue.

* Please **do not** use the issue tracker for support requests. Use [the Gitter chat](https://gitter.im/maxhelias/php-nominatim)

## Pull Requests

Good pull requests – patches, improvements, new features – are a fantastic help. Before create a pull request, please follow these instructions:

* The code must be `PSR-2` compliant
* Write some tests (in `tests/`)
* Write or edit a few examples if you have (in `examples`)
* And comment on your code for [phpDocumentor](https://www.phpdoc.org/)
