cybercog/youtrack-php-sdk

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing to PHP YouTrack SDK

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

## Workflow

- Fork the project.
- Make your bug fix or feature addition.
- Add tests for it. This is important so we don't break it in a future version unintentionally.
- Send a pull request. Bonus points for topic branches.

Please make sure that you have [set up your user name and email address](http://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git.

Pull requests for bug fixes must be based on the current stable branch.

We are trying to keep backwards compatibility breaks in PHP YouTrack SDK to an absolute minimum. Please take this into account when proposing changes.

Due to time constraints, we are not always able to respond as quickly as we would like. Please do not take delays personal and feel free to remind us if you feel that we forgot to respond.

## Coding Guidelines

This project comes with a configuration file for php-cs-fixer (.php_cs) that you can use to (re)format your sourcecode for compliance with this project's coding guidelines:

```shell script
$ vendor/bin/php-cs-fixer fix
```

## PHPUnit tests

The phpunit script can be used to invoke the PHPUnit test runner:

```shell script
$ composer test
```

## Reporting issues

- [General problems](https://github.com/cybercog/youtrack-php-sdk/issues)