Knowledge Base

¿Qué es esto?

git: Ejemplo fichero README.md

28/12/2015 - 18/12/2018 -  Comentarios - git General

## Synopsis

This PHP project pretends ...

## External libraries used

- Library for to query Jira with a PHP API: https://github.com/FayP/JIRA-php

- Composer

- PHP Gitlab API: https://travis-ci.org/m4tthumphrey/php-gitlab-api.svg?branch=master)](https://travis-ci.org/m4tthumphrey/php-gitlab-api

- Monolog

- Buzz http client: https://github.com/kriswallsmith/Buzz

## Contributors

Name Surname1 (mail@domain.com), Name Surname1 (mail2@domain.com)

## Coding conventions

### Coding Style:

For this project, every developer must follow the PSR coding conventions. It does not apply to third party library (PSR-1 and PSR-2 specifications should be enough for the most part of the project):

- PSR-1 (Basic Coding Standard): http://www.php-fig.org/psr/psr-1/

- PSR-2 (Coding Style Guide): http://www.php-fig.org/psr/psr-2/

- PSR-3 (Logger Interface): http://www.php-fig.org/psr/psr-3/

- PSR-4 (Autoloader):  http://www.php-fig.org/psr/psr-4/

- PSR-6 (Caching Interface): http://www.php-fig.org/psr/psr-6/

- PSR-7 (HTTP Message Interface): http://www.php-fig.org/psr/psr-7/

### Method names:

When we are setting or getting data, we must to start the method name with the action. Examples:

getIssueMetadata()

setIssueMetadata

### Documentation:

For documentation, we must follow PHP documentor convention: http://www.phpdoc.org/docs/latest/index.html

## License