Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .coveralls.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
service_name: travis-ci
src_dir: .
coverage_clover: clover.xml
json_path: coveralls-upload.json
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @traderinteractive/opensource
17 changes: 17 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contribution Guidelines
We welcome you to report [issues](/../../issues) or submit [pull requests](/../../pulls). While the below guidelines are necessary to get code merged, you can
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,
though, so if you can make sure the build is passing 100%, that would be very useful.

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
and we can get things merged in quicker when we understand its expected usage.

## Pull Requests
Code changes should be sent through [GitHub Pull Requests](/../../pulls). Before submitting the pull request, make sure that phpunit reports success
by running:
```sh
./vendor/bin/phpunit
```
## Builds
Our [Travis build](https://travis-ci.org/traderinteractive/dws-coding-standard) executes [PHPUnit](http://www.phpunit.de) and uses [Coveralls](https://coveralls.io/) to enforce code coverage.
While the build does not strictly enforce 100% code coverage, it will not allow coverage to drop below its current percentage.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## Expected Behavior

## Actual Behavior

## Steps to reproduce the behavior

8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Fixes # .

#### What does this PR do?

#### Checklist
- [ ] Pull request contains a clear definition of changes
- [ ] Tests (either unit, integration, or acceptance) written and passing
- [ ] Relevant documentation produced and/or updated
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/coverage/
/vendor/
/clover.xml
composer.lock
19 changes: 16 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
language: php
php:
- 7.0
- 5.6
script: ./build.php
after_script: ./vendor/bin/coveralls -v
- 7.0
- 7.1
- 7.2
- nightly
env:
- PREFER_LOWEST="--prefer-lowest --prefer-stable"
- PREFER_LOWEST=""
matrix:
fast_finish: true
allow_failures:
- php: nightly
before_script:
- composer update $PREFER_LOWEST
script:
- ./vendor/bin/phpunit --coverage-clover clover.xml
after_success: ./vendor/bin/coveralls -v
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License

Copyright (c) 2013 Dominion Enterprises
Copyright (c) 2017 Trader Interactive

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
Expand Down
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# DWS Coding Standard
[![Build Status](https://travis-ci.org/dominionenterprises/dws-coding-standard.png)](https://travis-ci.org/dominionenterprises/dws-coding-standard)
[![Code Coverage](http://img.shields.io/coveralls/dominionenterprises/dws-coding-standard.svg?style=flat)](https://coveralls.io/r/dominionenterprises/dws-coding-standard)
[![Build Status](https://travis-ci.org/traderinteractive/dws-coding-standard.svg?branch=master)](https://travis-ci.org/traderinteractive/dws-coding-standard)
[![Coverage Status](https://coveralls.io/repos/github/traderinteractive/dws-coding-standard/badge.svg)](https://coveralls.io/github/traderinteractive/dws-coding-standard)

[![Latest Stable Version](https://poser.pugx.org/traderinteractive/coding-standard/v/stable)](https://packagist.org/packages/traderinteractive/coding-standard)
[![Latest Unstable Version](https://poser.pugx.org/traderinteractive/coding-standard/v/unstable)](https://packagist.org/packages/traderinteractive/coding-standard)
[![License](https://poser.pugx.org/traderinteractive/coding-standard/license)](https://packagist.org/packages/traderinteractive/coding-standard)

[![Total Downloads](https://poser.pugx.org/traderinteractive/coding-standard/downloads)](https://packagist.org/packages/traderinteractive/coding-standard)
[![Daily Downloads](https://poser.pugx.org/traderinteractive/coding-standard/d/daily)](https://packagist.org/packages/traderinteractive/coding-standard)
[![Monthly Downloads](https://poser.pugx.org/traderinteractive/coding-standard/d/monthly)](https://packagist.org/packages/traderinteractive/coding-standard)

A fairly complete [PHP_CodeSniffer](http://www.squizlabs.com/php-codesniffer) coding standard. See the [standard document](standard.md) to
see what "sniffs" are enforced.
Expand All @@ -9,31 +17,27 @@ see what "sniffs" are enforced.

This standard is meant to be used in a project using [Composer](http://getcomposer.org). It can be added to your project's composer.json as follows:

```json
{
"require-dev": {
"dominionenterprises/dws-coding-standard": "~1.0"
}
}
```sh
composer require traderinteractive/coding-standard
```

Then to use it, you can run the following (or add to your build process):

```bash
./vendor/bin/phpcs --standard=$(pwd)/vendor/dominionenterprises/dws-coding-standard/DWS YOUR_FILES_AND_DIRECTORIES
./vendor/bin/phpcs --standard=$(pwd)/vendor/traderinteractive/coding-standard/DWS YOUR_FILES_AND_DIRECTORIES
```

## Contact

Developers may be contacted at:

* [Pull Requests](https://github.com/dominionenterprises/dws-coding-standard/pulls)
* [Issues](https://github.com/dominionenterprises/dws-coding-standard/issues)
* [Pull Requests](https://github.com/traderinteractive/dws-coding-standard/pulls)
* [Issues](https://github.com/traderinteractive/dws-coding-standard/issues)

## Tests

Tests for the sniffs are included, and are run using the included build:

```bash
./build.php
./vendor/bin/phpunit
```
36 changes: 0 additions & 36 deletions build.php

This file was deleted.

13 changes: 8 additions & 5 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "dominionenterprises/dws-coding-standard",
"name": "traderinteractive/coding-standard",
"description": "DWS Coding standard",
"keywords": ["phpcs", "coding", "standard"],
"authors": [
Expand All @@ -20,12 +20,15 @@
}
],
"license": "MIT",
"config": {
"sort-packages": true
},
"require": {
"php": "~5.6 || ~7.0",
"squizlabs/php_codesniffer": "~2.6"
"php": "^5.6 || ^7.0",
"squizlabs/php_codesniffer": "^2.6"
},
"require-dev": {
"phpunit/phpunit": "~5.5",
"satooshi/php-coveralls": "~1.0"
"php-coveralls/php-coveralls": "^1.0",
"phpunit/phpunit": "^5.5"
}
}
Loading