Skip to content
This repository has been archived by the owner on Jan 21, 2020. It is now read-only.

Commit

Permalink
Merging develop to master in preparation for 1.3.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
weierophinney committed May 8, 2018
2 parents 840ee42 + 9a2a152 commit 4f8ce00
Show file tree
Hide file tree
Showing 20 changed files with 978 additions and 480 deletions.
16 changes: 9 additions & 7 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
/test export-ignore
.coveralls.yml export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.travis.yml export-ignore
phpcs.xml export-ignore
phpunit.xml.dist export-ignore
/.coveralls.yml export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/composer.lock export-ignore
/docs/ export-ignore
/phpcs.xml export-ignore
/phpunit.xml.dist export-ignore
/test/ export-ignore
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
vendor/
phpunit.xml
clover.xml
coveralls-upload.json
/clover.xml
/coveralls-upload.json
/phpunit.xml
/vendor/
32 changes: 14 additions & 18 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@ language: php
cache:
directories:
- $HOME/.composer/cache
- vendor

env:
global:
- COMPOSER_ARGS="--no-interaction"
- COVERAGE_DEPS="satooshi/php-coveralls"
- LEGACY_DEPS="phpunit/phpunit doctrine/instantiator"
- COVERAGE_DEPS="php-coveralls/php-coveralls"

matrix:
include:
Expand All @@ -21,7 +19,7 @@ matrix:
- php: 5.6
env:
- DEPS=locked
- TEST_COVERAGE=true
- LEGACY_DEPS="phpunit/phpunit"
- php: 5.6
env:
- DEPS=latest
Expand All @@ -31,7 +29,7 @@ matrix:
- php: 7
env:
- DEPS=locked
- CS_CHECK=true
- LEGACY_DEPS="phpunit/phpunit"
- php: 7
env:
- DEPS=latest
Expand All @@ -41,40 +39,38 @@ matrix:
- php: 7.1
env:
- DEPS=locked
- CS_CHECK=true
- TEST_COVERAGE=true
- php: 7.1
env:
- DEPS=latest
- php: hhvm
- php: 7.2
env:
- DEPS=lowest
- php: hhvm
- php: 7.2
env:
- DEPS=locked
- php: hhvm
- php: 7.2
env:
- DEPS=latest
allow_failures:
- php: hhvm

notifications:
irc: "irc.freenode.org#apigility-dev"
email: false

before_install:
- if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
- travis_retry composer self-update

install:
- travis_retry composer install $COMPOSER_ARGS --ignore-platform-reqs
- if [[ $TRAVIS_PHP_VERSION =~ ^5.6 ]]; then travis_retry composer update $COMPOSER_ARGS --with-dependencies $LEGACY_DEPS ; fi
- if [[ $LEGACY_DEPS != '' ]]; then travis_retry composer update $COMPOSER_ARGS --with-dependencies $LEGACY_DEPS ; fi
- if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi
- if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable $COMPOSER_ARGS ; fi
- if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer require --dev $COMPOSER_ARGS $COVERAGE_DEPS ; fi
- composer show
- stty cols 120 && composer show

script:
- if [[ $TEST_COVERAGE == 'true' ]]; then composer test-coverage ; else composer test ; fi
- if [[ $CS_CHECK == 'true' ]]; then composer cs-check ; fi

after_script:
- if [[ $TEST_COVERAGE == 'true' ]]; then composer upload-coverage ; fi
- if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry php vendor/bin/php-coveralls -v ; fi

notifications:
email: false
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

All notable changes to this project will be documented in this file, in reverse chronological order by release.

## 1.2.4 - TBD
## 1.3.0 - 2018-05-08

### Added

- [#58](https://github.com/zfcampus/zf-api-problem/pull/58) adds support for PHP 7.2.

### Changed

- Nothing.

### Deprecated
Expand All @@ -14,7 +18,7 @@ All notable changes to this project will be documented in this file, in reverse

### Removed

- Nothing.
- [#58](https://github.com/zfcampus/zf-api-problem/pull/58) removes support for HHVM.

### Fixed

Expand Down
2 changes: 1 addition & 1 deletion CONDUCT.md → CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributor Code of Conduct

The Zend Framework project adheres to [The Code Manifesto](http://codemanifesto.com)
This project adheres to [The Code Manifesto](http://codemanifesto.com)
as its guidelines for contributor interactions.

## The Code Manifesto
Expand Down
201 changes: 155 additions & 46 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,189 @@
# CONTRIBUTING

Apigility and related modules (of which this is one) are open source and licensed
as [BSD-3-Clause](http://opensource.org/licenses/BSD-3-Clause). Contributions
are welcome in the form of issue reports and pull requests.

All pull requests should include unit tests when applicable, and should follow
our coding standards (more on these below); failure to do so may result in
rejection of the pull request. If you need help writing tests, please ask on the
developer mailing list and/or in IRC.

## RESOURCES

If you wish to contribute to Apigility modules, please be sure to
If you wish to contribute to this project, please be sure to
read/subscribe to the following resources:

- [Coding Standards](https://github.com/zendframework/zf2/wiki/Coding-Standards)
- [ZF Git Guide](https://github.com/zendframework/zf2/blob/master/README-GIT.md)
- [Apigility developer mailing list](http://bit.ly/apigility-dev)
- Apigility developer IRC channel: #apigility-dev on Freenode.net
- [Coding Standards](https://github.com/zendframework/zend-coding-standard)
- [Forums](https://discourse.zendframework.com/c/contributors)
- [Chat](https://zendframework-slack.herokuapp.com)
- [Code of Conduct](CODE_OF_CONDUCT.md)

If you are working on new features or refactoring
[create a proposal](https://github.com/zfcampus/zf-api-problem/issues/new).

If you are working on new features, refactoring an existing module, or proposing
a new module, please send an email to the developer mailing list.
## RUNNING TESTS

## REPORTING POTENTIAL SECURITY ISSUES
To run tests:

If you have encountered a potential security vulnerability in any Apigility
module, please report it to us at [[email protected]](mailto:[email protected]).
We will work with you to verify the vulnerability and patch it.
- Clone the repository:

When reporting issues, please provide the following information:
```console
$ git clone git://github.com/zfcampus/zf-api-problem.git
$ cd zf-api-problem
```

- Module(s) affected
- A description indicating how to reproduce the issue
- A summary of the security vulnerability and impact
- Install dependencies via composer:

We request that you contact us via the email address above and give the project
contributors a chance to resolve the vulnerability and issue a new release prior
to any public exposure; this helps protect Apigility users, and provides them
with a chance to upgrade and/or update in order to protect their applications.
```console
$ composer install
```

For sensitive email communications, please use
[our PGP key](http://framework.zend.com/zf-security-pgp-key.asc).
If you don't have `composer` installed, please download it from https://getcomposer.org/download/

## RUNNING TESTS
- Run the tests using the "test" command shipped in the `composer.json`:

```console
$ composer test
```

First, use [Composer](https://getcomposer.org) to install all dependencies:
You can turn on conditional tests with the `phpunit.xml` file.
To do so:

- Copy `phpunit.xml.dist` file to `phpunit.xml`
- Edit `phpunit.xml` to enable any specific functionality you
want to test, as well as to provide test values to utilize.

## Running Coding Standards Checks

First, ensure you've installed dependencies via composer, per the previous
section on running tests.

To run CS checks only:

```console
$ composer install
$ composer cs-check
```

To run tests, use the PHPUnit executable installed by Composer:
To attempt to automatically fix common CS issues:

```console
$ composer test
$ composer cs-fix
```

## CODING STANDARDS
If the above fixes any CS issues, please re-run the tests to ensure
they pass, and make sure you add and commit the changes after verification.

## Recommended Workflow for Contributions

Your first step is to establish a public repository from which we can
pull your work into the master repository. We recommend using
[GitHub](https://github.com), as that is where the component is already hosted.

1. Setup a [GitHub account](https://github.com/), if you haven't yet
2. Fork the repository (https://github.com/zfcampus/zf-api-problem)
3. Clone the canonical repository locally and enter it.

```console
$ git clone git://github.com/zfcampus/zf-api-problem.git
$ cd zf-api-problem
```

4. Add a remote to your fork; substitute your GitHub username in the command
below.

```console
$ git remote add {username} [email protected]:{username}/zf-api-problem.git
$ git fetch {username}
```

### Keeping Up-to-Date

Periodically, you should update your fork or personal repository to
match the canonical ZF repository. Assuming you have setup your local repository
per the instructions above, you can do the following:

While Apigility uses Zend Framework 2 coding standards, in practice, we check
standards against PSR-1/2. To check for CS issues:

```console
$ composer cs-check
$ git checkout master
$ git fetch origin
$ git rebase origin/master
# OPTIONALLY, to keep your remote up-to-date -
$ git push {username} master:master
```

If you're tracking other branches -- for example, the "develop" branch, where
new feature development occurs -- you'll want to do the same operations for that
branch; simply substitute "develop" for "master".

### Working on a patch

We recommend you do each new feature or bugfix in a new branch. This simplifies
the task of code review as well as the task of merging your changes into the
canonical repository.

A typical workflow will then consist of the following:

1. Create a new local branch based off either your master or develop branch.
2. Switch to your new local branch. (This step can be combined with the
previous step with the use of `git checkout -b`.)
3. Do some work, commit, repeat as necessary.
4. Push the local branch to your remote repository.
5. Send a pull request.

The mechanics of this process are actually quite trivial. Below, we will
create a branch for fixing an issue in the tracker.

```console
$ git checkout -b hotfix/9295
Switched to a new branch 'hotfix/9295'
```

This will report CS issues. You can also attempt to fix many reported errors
automatically:
... do some work ...


```console
$ composer cs-fix
$ git commit
```

If you use `cs-fix` to fix issues, make certain you add and commit any files
changed!
... write your log message ...


```console
$ git push {username} hotfix/9295:hotfix/9295
Counting objects: 38, done.
Delta compression using up to 2 threads.
Compression objects: 100% (18/18), done.
Writing objects: 100% (20/20), 8.19KiB, done.
Total 20 (delta 12), reused 0 (delta 0)
To ssh://[email protected]/{username}/zf-api-problem.git
b5583aa..4f51698 HEAD -> master
```

To send a pull request, you have two options.

If using GitHub, you can do the pull request from there. Navigate to
your repository, select the branch you just created, and then select the
"Pull Request" button in the upper right. Select the user/organization
"zfcampus" (or whatever the upstream organization is) as the recipient.

#### What branch to issue the pull request against?

Which branch should you issue a pull request against?

- For fixes against the stable release, issue the pull request against the
"master" branch.
- For new features, or fixes that introduce new elements to the public API (such
as new public methods or properties), issue the pull request against the
"develop" branch.

### Branch Cleanup

As you might imagine, if you are a frequent contributor, you'll start to
get a ton of branches both locally and on your remote.

Once you know that your changes have been accepted to the master
repository, we suggest doing some cleanup of these branches.

- Local branch cleanup

```console
$ git branch -d <branchname>
```

## Conduct
- Remote branch removal

Please see our [CONDUCT.md](CONDUCT.md) to understand expected behavior when interacting with others in the project.
```console
$ git push {username} :<branchname>
```
Loading

0 comments on commit 4f8ce00

Please sign in to comment.