blob: 478fae45c0d122a8984302a29ba86568d107cdf9 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
# Contribution Guidelines
This project is wide open to contributions. You can use GitHub to [report
issues][issues] or [submit pull requests][pull-requests]. When opening pull
requests, it is recommended to follow these guidelines in order to grease the
wheels, so to speak.
Please include as many details as you can in any issues and pull requests.
Understanding how you are using the library and exactly what problems you are
having can also help make things move quickly.
## Building
There is an included [build script][build-script] that you can execute locally
to run the code through the [PSR-1 coding standard][psr-1] and the
[PHPUnit][phpunit] test suite. Code coverage is kept at 100% according to
PHPUnit's code coverage report. This is inforced using
[coveralls][coveralls].
Alternatively, you can use [Docker][docker] and/or [Docker
Compose][docker-compose] to execute the build:
```bash
docker-compose run build
```
## Automated builds
Pull requests will automatically have a build kicked off on [Travis
CI][travis-ci] and [Scrutinizer CI][scrutinizer-ci]. The results of these
builds are monitored closely for all pull requests.
[issues]: https://github.com/nubs/random-name-generator/issues
[pull-requests]: https://github.com/nubs/random-name-generator/pulls
[build-script]: https://github.com/nubs/random-name-generator/blob/master/build.php
[psr-1]: http://www.php-fig.org/psr/psr-1/ "PSR-1 - Basic Coding Standard"
[phpunit]: http://phpunit.de/ "PHPUnit - The PHP Testing Framework"
[travis-ci]: https://travis-ci.org/nubs/random-name-generator
[scrutinizer-ci]: https://scrutinizer-ci.com/g/nubs/random-name-generator/
[coveralls]: https://coveralls.io/github/nubs/random-name-generator
[docker]: https://docker.com/ "Docker - Build, Ship, and Run Any App, Anywhere"
[docker-compose]: https://www.docker.com/docker-compose
|
