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

Updated docs and support documents + PHPUnit 7 support #85

Merged
merged 23 commits into from
Apr 12, 2018
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
555985b
Renamed documentation directory: doc -> docs
michalbundyra Oct 25, 2017
d7b622c
Suport files moved into docs directory + update
michalbundyra Oct 25, 2017
1e1e63c
Renamed directory with benchmarks -> "benchmark"
michalbundyra Oct 25, 2017
7c974a3
Updated year in mkdocs.yml and LICENSE.md
michalbundyra Oct 25, 2017
6e9335b
Updated composer skeleton
michalbundyra Oct 25, 2017
a54ad0c
Fixed directory name in .gitattributes
michalbundyra Oct 25, 2017
04ee848
Added rss link in composer.json
michalbundyra Oct 25, 2017
d587312
Removed type "library" in composer.json as it is default type
michalbundyra Oct 25, 2017
7ce9664
Updated PHPUnit configuration
michalbundyra Oct 25, 2017
11ccc1b
Removed unused redundant PHPUnit bootstrap
michalbundyra Nov 2, 2017
b42aa75
Removed unused PHPUnit env variable
michalbundyra Nov 2, 2017
bc9abef
Added phpbench.json into .gitattributes
michalbundyra Nov 8, 2017
c946176
Removed empty line in LICENSE.md
michalbundyra Nov 8, 2017
d769ba4
Updated coverage badge in README.md
michalbundyra Nov 8, 2017
49be59e
Added ISSUE and PR templates
michalbundyra Nov 8, 2017
18a1bea
Updated .gitattributes and .gitignore - natsort
michalbundyra Nov 8, 2017
6dcbd67
Updated copyright year range in mkdocs.yml to match LICENSE.md
michalbundyra Nov 8, 2017
b7f954e
Removed white characters at the end of the line in the docs
michalbundyra Nov 22, 2017
e152aee
Updated php-coveralls
michalbundyra Apr 12, 2018
09b84a2
Updated copyright year range in LICENSE.md and mkdocs.yml
michalbundyra Apr 12, 2018
8695661
Updated link to https in mkdocs.yml
michalbundyra Apr 12, 2018
63c15f0
Updated branch aliases in composer.json and deps to allow PHPUnit 7
michalbundyra Apr 12, 2018
cf2b976
Updated .gitattributes - added trailing / for benchamrk directory
michalbundyra Apr 12, 2018
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
18 changes: 10 additions & 8 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
/benchmarks export-ignore
/docs export-ignore
/test export-ignore
/vendor export-ignore
.coveralls.yml export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.travis.yml export-ignore
.composer.lock export-ignore
phpbench.json 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
/mkdocs.yml export-ignore
/phpcs.xml export-ignore
/phpunit.xml.dist export-ignore
15 changes: 3 additions & 12 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
.buildpath
.DS_Store
.idea
.project
.settings/
.*.sw*
.*.un~
nbproject
doc/html/
tmp/
docs/html/
vendor/
zf-mkdoc-theme/

clover.xml
coveralls-upload.json
phpunit.xml
vendor
zf-mkdoc-theme.tgz
12 changes: 6 additions & 6 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Copyright (c) 2005-2015, Zend Technologies USA, Inc.
Copyright (c) 2005-2017, Zend Technologies USA, Inc.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should use a script for these changes. (zendframework/maintainers#6)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, haven't seen it. We need then the script there 😄


All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

- Neither the name of Zend Technologies USA, Inc. nor the names of its
contributors may be used to endorse or promote products derived from this
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class for different scopes like:

We provide scripts for benchmarking zend-stdlib using the
[PHPBench](/~https://github.com/phpbench/phpbench) framework; these can be
found in the `benchmarks/` directory.
found in the `benchmark/` directory.

To execute the benchmarks you can run the following command:

Expand Down
2 changes: 1 addition & 1 deletion CONDUCT.md → docs/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
105 changes: 25 additions & 80 deletions CONTRIBUTING.md → docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,73 +2,43 @@

## RESOURCES

If you wish to contribute to Zend Framework, 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)
- [Contributor's Guide](http://framework.zend.com/participate/contributor-guide)
- ZF Contributor's mailing list:
Archives: http://zend-framework-community.634137.n4.nabble.com/ZF-Contributor-f680267.html
Subscribe: zf-contributors-subscribe@lists.zend.com
- ZF Contributor's IRC channel:
#zftalk.dev on Freenode.net
- [Coding Standards](/~https://github.com/zendframework/zend-coding-standard)
- [Forums](https://discourse.zendframework.com/c/contributors)
- [Slack](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/zendframework/zend-stdlib/issues/new).

## Reporting Potential Security Issues

If you have encountered a potential security vulnerability, please **DO NOT** report it on the public
issue tracker: send it to us at [zf-security@zend.com](mailto:zf-security@zend.com) instead.
We will work with you to verify the vulnerability and patch it as soon as possible.

When reporting issues, please provide the following information:

- Component(s) affected
- A description indicating how to reproduce the issue
- A summary of the security vulnerability and impact

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 users and provides them with a chance
to upgrade and/or update in order to protect their applications.

For sensitive email communications, please use [our PGP key](http://framework.zend.com/zf-security-pgp-key.asc).
If you are working on new features or refactoring
[create a proposal](/~https://github.com/zendframework/zend-stdlib/issues/new).

## RUNNING TESTS

> ### Note: testing versions prior to 2.4
>
> This component originates with Zend Framework 2. During the lifetime of ZF2,
> testing infrastructure migrated from PHPUnit 3 to PHPUnit 4. In most cases, no
> changes were necessary. However, due to the migration, tests may not run on
> versions < 2.4. As such, you may need to change the PHPUnit dependency if
> attempting a fix on such a version.

To run tests:

- Clone the repository:

```console
$ git clone git@github.com:zendframework/zend-stdlib.git
$ cd
$ git clone git://github.com/zendframework/zend-stdlib.git
$ cd zend-stdlib
```

- Install dependencies via composer:

```console
$ curl -sS https://getcomposer.org/installer | php --
$ ./composer.phar install
$ composer install
```

If you don't have `curl` installed, you can also download `composer.phar` from https://getcomposer.org/
If you don't have `composer` installed, please download it from https://getcomposer.org/download/

- Run the tests via `phpunit` and the provided PHPUnit config, like in this example:
- Run the tests using the "test" command shipped in the `composer.json`:

```console
$ ./vendor/bin/phpunit
$ composer test
```

You can turn on conditional tests with the phpunit.xml file.
You can turn on conditional tests with the `phpunit.xml` file.
To do so:

- Copy `phpunit.xml.dist` file to `phpunit.xml`
Expand All @@ -77,48 +47,36 @@ To do so:

## Running Coding Standards Checks

This component uses [php-cs-fixer](http://cs.sensiolabs.org/) for coding
standards checks, and provides configuration for our selected checks.
`php-cs-fixer` is installed by default via Composer.
First, ensure you've installed dependencies via composer, per the previous
section on running tests.

To run checks only:
To run CS checks only:

```console
$ ./vendor/bin/php-cs-fixer fix . -v --diff --dry-run --config-file=.php_cs
$ composer cs-check
```

To have `php-cs-fixer` attempt to fix problems for you, omit the `--dry-run`
flag:
To attempt to automatically fix common CS issues:

```console
$ ./vendor/bin/php-cs-fixer fix . -v --diff --config-file=.php_cs
$ composer cs-fix
```

If you allow php-cs-fixer to fix CS issues, please re-run the tests to ensure
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.

## Benchmarks

We provide benchmark tests for zend-stdlib under the directory [benchmark/](benchmark/),
using. [athletic](/~https://github.com/polyfractal/athletic). You can execute
the benchmarks running the following command:

```bash
$ ./vendor/bin/athletic -p benchmark
```

## 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](http://github.com/), if you haven't yet
2. Fork the repository (http://github.com/zendframework/zend-stdlib)
1. Setup a [GitHub account](https://github.com/), if you haven't yet
2. Fork the repository (https://github.com/zendframework/zend-stdlib)
3. Clone the canonical repository locally and enter it.

```console
$ git clone git://github.com:zendframework/zend-stdlib.git
$ git clone git://github.com/zendframework/zend-stdlib.git
$ cd zend-stdlib
```

Expand Down Expand Up @@ -198,15 +156,7 @@ 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
"zendframework" as the recipient.

If using your own repository - or even if using GitHub - you can use `git
format-patch` to create a patchset for us to apply; in fact, this is
**recommended** for security-related patches. If you use `format-patch`, please
send the patches as attachments to:

- zf-devteam@zend.com for patches without security implications
- zf-security@zend.com for security patches
"zendframework" (or whatever the upstream organization is) as the recipient.

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

Expand Down Expand Up @@ -237,8 +187,3 @@ repository, we suggest doing some cleanup of these branches.
```console
$ git push {username} :<branchname>
```


## Conduct

Please see our [CONDUCT.md](CONDUCT.md) to understand expected behavior when interacting with others in the project.
25 changes: 25 additions & 0 deletions docs/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Getting Support

Zend Framework offers three support channels:

- For real-time questions, use our
[Slack](https://zendframework-slack.herokuapp.com)
- For detailed questions (e.g., those requiring examples) use our
[forums](https://discourse.zendframework.com/c/questions/components)
- To report issues, use this repository's
[issue tracker](/~https://github.com/zendframework/zend-stdlib/issues/new)

**DO NOT** use the issue tracker to ask questions; use Slack or the forums for
that. Questions posed to the issue tracker will be closed.

When reporting an issue, please include the following details:

- A narrative description of what you are trying to accomplish.
- The minimum code necessary to reproduce the issue.
- The expected results of exercising that code.
- The actual results received.

We may ask for additional details: what version of the library you are using,
and what PHP version was used to reproduce the issue.

You may also submit a failing test case as a pull request.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
docs_dir: doc/book
site_dir: doc/html
docs_dir: docs/book
site_dir: docs/html
pages:
- index.md
- Reference:
Expand All @@ -8,4 +8,4 @@ pages:
site_name: zend-stdlib
site_description: Zend\Stdlib
repo_url: '/~https://github.com/zendframework/zend-stdlib'
copyright: 'Copyright (c) 2016 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'
copyright: 'Copyright (c) 2017 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'
2 changes: 1 addition & 1 deletion phpbench.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"bootstrap": "vendor/autoload.php",
"path": "benchmarks",
"path": "benchmark",
"retry_threshold": 5
}