hendrikmaus/reynaldo

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing

Please note that this project is released with a
[Contributor Code of Conduct](http://contributor-covenant.org/version/1/2/0/).
By participating in this project you agree to abide by its terms.

## Reporting Issues

Before you report any issue, please make sure that you actually deal with an issue of this library
and not with an issue of your api description parser, e.g. drafter itself

## Installation from Source

Prior to contributing, you must be able to run the test suite.
To achieve this, you need to acquire the source code and install all dependencies:

1. Run `git clone https://github.com/hendrikmaus/reynaldo.git`
2. Get [composer](https://getcomposer.org/)
3. `cd reynaldo && composer install`

Composer will take care of installing all required dependencies.
Watch the command output to spot errors.

## Run the tests
You can either use `composer test` or `vendor/bin/phpunit`.

## Contributing policy

Fork the project, create a feature branch, and send us a pull request.
If you would like to help, take a look at the [list of open issues](https://github.com/hendrikmaus/reynaldo/issues).