Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
sagikazarmark committed May 30, 2015
0 parents commit 0c76879
Show file tree
Hide file tree
Showing 10 changed files with 253 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .editorconfig
@@ -0,0 +1,13 @@
root = true

[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 4

[*.yml*]
indent_style = space
indent_size = 2
8 changes: 8 additions & 0 deletions .gitattributes
@@ -0,0 +1,8 @@
tests/ export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.scrutinizer.yml export-ignore
.travis.yml export-ignore
CONTRIBUTING.md export-ignore
phpunit.xml.dist export-ignore
4 changes: 4 additions & 0 deletions .gitignore
@@ -0,0 +1,4 @@
vendor/
composer.phar
composer.lock
phpunit.xml
7 changes: 7 additions & 0 deletions .scrutinizer.yml
@@ -0,0 +1,7 @@
checks:
php:
code_rating: true
duplication: true

tools:
external_code_coverage: true
29 changes: 29 additions & 0 deletions .travis.yml
@@ -0,0 +1,29 @@
language: php

php:
- 5.4
- 5.5
- 5.6
- 7.0
- hhvm

matrix:
allow_failures:
- php: 7.0
- php: hhvm
include:
- php: 5.4
env:
- COMPOSER_FLAGS="--prefer-lowest --prefer-stable"
- COVERAGE=true
- PHPUNIT_FLAGS="--coverage-clover=coverage.clover"

install:
- travis_retry composer update ${COMPOSER_FLAGS} --prefer-source --no-interaction

script:
- vendor/bin/phpunit ${PHPUNIT_FLAGS}

after_script:
- if [[ "$COVERAGE" = true ]]; then wget https://scrutinizer-ci.com/ocular.phar; fi
- if [[ "$COVERAGE" = true ]]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi
66 changes: 66 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,66 @@
Contributing
============

Thank you for contributing to this project!

Bug reports
-----------

If you find a bug, please submit an issue. Try to be as detailed as possible
in your problem description to help us fix the bug.

Feature requests
----------------

If you wish to propose a feature, please submit an issue. Try to explain your
use case as fully as possible to help us understand why you think the feature
should be added.

Creating a pull request (PR)
----------------------------

First [fork the repository](https://help.github.com/articles/fork-a-repo/) on
GitHub.

Then clone your fork:

```bash
$ git clone https://github.com/your-name/repo-name.git
$ git checkout -b bug-or-feature-description
```

And install the dependencies:

```bash
$ composer install
```

Write your code and add tests. Then run the tests:

```bash
$ vendor/bin/phpunit
```

Commit your changes and push them to GitHub:

```bash
$ git commit -m "Fix nasty bug"
$ git push -u origin bug-or-feature-description
```

Then [create a pull request](https://help.github.com/articles/creating-a-pull-request/)
on GitHub.

If you need to make some changes, commit and push them as you like. When asked
to squash your commits, do so as follows:

```bash
git rebase -i
git push origin bug-or-feature-description -f
```

Coding standard
---------------

This project follows the [PSR-2](http://www.php-fig.org/psr/psr-2/) coding style.
Please make sure your pull requests adhere to this standard.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 PortPHP

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
39 changes: 39 additions & 0 deletions README.md
@@ -0,0 +1,39 @@
# portphp/steps

[![Latest Version](https://img.shields.io/github/release/portphp/steps.svg?style=flat-square)](https://github.com/portphp/steps/releases)
[![Build Status](https://travis-ci.org/portphp/steps.svg)](https://travis-ci.org/portphp/steps)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/portphp/steps/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/portphp/steps/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/portphp/steps/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/portphp/steps/?branch=master)

Step-based workflow for PortPHP.

## Installation

Open a command console, enter your project directory and execute the
following command to download the latest stable version of this package:

```bash
$ composer require portphp/steps
```

This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.

## Documentation

Documentation is available at https://portphp.readthedocs.org.

## Issues and feature requests

Please report issues and request features at https://github.com/portphp/portphp/issues.

## Contributing

Contributions are very welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for
details. Thanks to [everyone who has contributed](https://github.com/portphp/steps/graphs/contributors)
already.

## License

This package is licensed under the [MIT license](LICENSE).
46 changes: 46 additions & 0 deletions composer.json
@@ -0,0 +1,46 @@
{
"name": "portphp/steps",
"description": "Step aggregator for Port",
"license": "MIT",
"homepage": "https://github.com/portphp",
"authors": [
{
"name": "David de Boer",
"email": "david@ddeboer.nl"
},
{
"name": "Markus Bachmann",
"email": "markus.bachmann@bachi.biz"
},
{
"name": "Community contributors",
"homepage": "https://github.com/portphp/boilerplate/graphs/contributors"
}
],
"support": {
"issues": "https://github.com/portphp/portphp/issues",
"source": "https://github.com/portphp/boilerplate",
"docs": "https://portphp.readthedocs.org"
},
"require": {
"php": ">=5.4.0"
},
"autoload": {
"psr-4": {
"Port\\Steps\\": "src/"
}
},
"require-dev": {
"phpunit/phpunit": "^4.0"
},
"autoload-dev": {
"psr-4": {
"Port\\Steps\\Tests\\": "tests/"
}
},
"extra": {
"branch-alias": {
"dev-master": "1.0.x-dev"
}
}
}
20 changes: 20 additions & 0 deletions phpunit.xml.dist
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>

<phpunit backupGlobals="false"
backupStaticAttributes="false"
bootstrap="vendor/autoload.php"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false"
verbose="true"
>
<testsuites>
<testsuite name="portphp/steps">
<directory suffix=".php">./tests/</directory>
</testsuite>
</testsuites>
</phpunit>

0 comments on commit 0c76879

Please sign in to comment.