Skip to content

Commit 1b6673e

Browse files
authored
Merge pull request #1 from chadicus/master
Version 1
2 parents d16cc30 + 83e2dee commit 1b6673e

16 files changed

Lines changed: 235 additions & 1 deletion

.coveralls.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
service_name: travis-ci
2+
coverage_clover: clover.xml
3+
json_path: coveralls-upload.json

.gitattributes

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Enforce Unix newlines
2+
* text=lf
3+
4+
# Exclude unused files
5+
# see: https://redd.it/2jzp6k
6+
/tests export-ignore
7+
/.github export-ignore
8+
/.gitattributes export-ignore
9+
/.gitignore export-ignore
10+
/.*.yml export-ignore
11+
/*.xml.dist export-ignore
12+
/README.md export-ignore

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @traderinteractive/opensource

.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contribution Guidelines
2+
We welcome you to report [issues](/../../issues) or submit [pull requests](/../../pulls). While the below guidelines are necessary to get code merged, you can
3+
submit pull requests that do not adhere to them and we will try to take care of them in our spare time. We are a smallish group of developers,
4+
though, so if you can make sure the build is passing 100%, that would be very useful.
5+
6+
We recommend including details of your particular usecase(s) with any issues or pull requests. We love to hear how our libraries are being used
7+
and we can get things merged in quicker when we understand its expected usage.
8+
9+
## Pull Requests
10+
Code changes should be sent through [GitHub Pull Requests](/../../pulls). Before submitting the pull request, make sure that phpunit reports success
11+
by running:
12+
```sh
13+
./vendor/bin/phpunit
14+
```
15+
And there are not coding standard violations by running
16+
```sh
17+
./vendor/bin/phpcs
18+
```
19+
20+
## Builds
21+
Our [Travis build](https://travis-ci.org/traderinteractive/exceptions-php) executes [PHPUnit](http://www.phpunit.de) and uses [Coveralls](https://coveralls.io/) to enforce code coverage.
22+
While the build does not strictly enforce 100% code coverage, it will not allow coverage to drop below its current percentage.
23+
[Scrutinizer](https://scrutinizer-ci.com/) is used to ensure code quality and enforce the [coding standard](http://www.php-fig.org/psr/psr-2/).

.github/ISSUE_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Expected Behavior
2+
3+
## Actual Behavior
4+
5+
## Steps to reproduce the behavior
6+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Fixes # .
2+
3+
#### What does this PR do?
4+
5+
#### Checklist
6+
- [ ] Pull request contains a clear definition of changes
7+
- [ ] Tests (either unit, integration, or acceptance) written and passing
8+
- [ ] Relevant documentation produced and/or updated

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/vendor/
2+
composer.lock
3+
phpcs.xml
4+
phpunit.xml
5+
clover.xml

.scrutinizer.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
filter:
2+
excluded_paths:
3+
- 'vendor/*'
4+
before_commands:
5+
- 'composer install'
6+
tools:
7+
php_analyzer: true
8+
php_mess_detector: true
9+
php_code_sniffer:
10+
config:
11+
standard: PSR2
12+
sensiolabs_security_checker: true
13+
php_loc:
14+
excluded_dirs:
15+
- vendor
16+
php_pdepend: true
17+
php_sim: true
18+
build_failure_conditions:
19+
- 'elements.rating(< A).new.exists'
20+
- 'issues.label("coding-style").new.exists'
21+
- 'issues.severity(>= MAJOR).new.exists'
22+
- 'project.metric("scrutinizer.quality", < 10)'

.travis.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
language: php
2+
php:
3+
- 7.0
4+
- 7.1
5+
- 7.2
6+
- nightly
7+
env:
8+
- PREFER_LOWEST="--prefer-lowest --prefer-stable"
9+
- PREFER_LOWEST=""
10+
matrix:
11+
fast_finish: true
12+
allow_failures:
13+
- php: nightly
14+
before_script:
15+
- composer update $PREFER_LOWEST
16+
script:
17+
- ./vendor/bin/phpunit
18+
after_success: ./vendor/bin/coveralls -v

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2018 Trader Interactive
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)