Updated root assets

- Updated .gitattributes - Removed assets from the list that no longer exist - Removed `composer.lock` and added it to the `.gitignore` rules - Updated `CONTRIBUTING.md` to mirror those of the components, and to add links to each component repository. - Moved `LICENSE.txt` to `LICENSE.md` and formatted as markdown. - Removed `README-GIT.md` as it's no longer necessary. - Updated `INSTALL.md` to only detail installation via `composer require`. - Minor updates to `README.md`.
ThaDafinser · Jun 3, 2015 · 7e800a7 · 7e800a7
1 parent b071e43
commit 7e800a7
Show file tree

Hide file tree

Showing 8 changed files with 203 additions and 2,415 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,8 +1,3 @@
-/tests export-ignore
 /vendor export-ignore
-/demos export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-.travis.yml export-ignore
-.php_cs export-ignore
-build.xml export-ignore
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ build/
 nbproject
 tmp/
 vendor/
+composer.lock
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,21 +5,77 @@
 If you wish to contribute to Zend Framework, please be sure to
 read/subscribe to the following resources:
 
- -  [Coding Standards](http://framework.zend.com/wiki/display/ZFDEV2/Coding+Standards)
- -  [ZF Git Guide](README-GIT.md)
+ -  [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
 
-If you are working on new features, or refactoring an existing
-component, please [create a proposal](https://github.com/zendframework/zf2/issues/new).
+If you are working on new features or refactoring [create a proposal](https://github.com/zendframework/zf2/issues/new).
+
+## Components
+
+This package is primarily a meta-package, declaring a host of ZF components as
+dependencies. These are listed below, with links to each repository; most issues
+and pull requests rightfully belong against the individual components and should
+be made accordingly.
+
+- [zend-authentication](https://github.com/zendframework/zend-authentication)
+- [zend-barcode](https://github.com/zendframework/zend-barcode)
+- [zend-cache](https://github.com/zendframework/zend-cache)
+- [zend-captcha](https://github.com/zendframework/zend-captcha)
+- [zend-code](https://github.com/zendframework/zend-code)
+- [zend-config](https://github.com/zendframework/zend-config)
+- [zend-console](https://github.com/zendframework/zend-console)
+- [zend-crypt](https://github.com/zendframework/zend-crypt)
+- [zend-db](https://github.com/zendframework/zend-db)
+- [zend-debug](https://github.com/zendframework/zend-debug)
+- [zend-di](https://github.com/zendframework/zend-di)
+- [zend-dom](https://github.com/zendframework/zend-dom)
+- [zend-escaper](https://github.com/zendframework/zend-escaper)
+- [zend-eventmanager](https://github.com/zendframework/zend-eventmanager)
+- [zend-feed](https://github.com/zendframework/zend-feed)
+- [zend-file](https://github.com/zendframework/zend-file)
+- [zend-filter](https://github.com/zendframework/zend-filter)
+- [zend-form](https://github.com/zendframework/zend-form)
+- [zend-http](https://github.com/zendframework/zend-http)
+- [zend-i18n](https://github.com/zendframework/zend-i18n)
+- [zend-inputfilter](https://github.com/zendframework/zend-inputfilter)
+- [zend-json](https://github.com/zendframework/zend-json)
+- [zend-ldap](https://github.com/zendframework/zend-ldap)
+- [zend-loader](https://github.com/zendframework/zend-loader)
+- [zend-log](https://github.com/zendframework/zend-log)
+- [zend-mail](https://github.com/zendframework/zend-mail)
+- [zend-math](https://github.com/zendframework/zend-math)
+- [zend-memory](https://github.com/zendframework/zend-memory)
+- [zend-mime](https://github.com/zendframework/zend-mime)
+- [zend-modulemanager](https://github.com/zendframework/zend-modulemanager)
+- [zend-mvc](https://github.com/zendframework/zend-mvc)
+- [zend-navigation](https://github.com/zendframework/zend-navigation)
+- [zend-paginator](https://github.com/zendframework/zend-paginator)
+- [zend-permissions-acl](https://github.com/zendframework/zend-permissions-acl)
+- [zend-permissions-rbac](https://github.com/zendframework/zend-permissions-rbac)
+- [zend-progressbar](https://github.com/zendframework/zend-progressbar)
+- [zend-serializer](https://github.com/zendframework/zend-serializer)
+- [zend-server](https://github.com/zendframework/zend-server)
+- [zend-servicemanager](https://github.com/zendframework/zend-servicemanager)
+- [zend-session](https://github.com/zendframework/zend-session)
+- [zend-soap](https://github.com/zendframework/zend-soap)
+- [zend-stdlib](https://github.com/zendframework/zend-stdlib)
+- [zend-tag](https://github.com/zendframework/zend-tag)
+- [zend-test](https://github.com/zendframework/zend-test)
+- [zend-text](https://github.com/zendframework/zend-text)
+- [zend-uri](https://github.com/zendframework/zend-uri)
+- [zend-validator](https://github.com/zendframework/zend-validator)
+- [zend-version](https://github.com/zendframework/zend-version)
+- [zend-view](https://github.com/zendframework/zend-view)
+- [zend-xmlrpc](https://github.com/zendframework/zend-xmlrpc)
 
 ## Reporting Potential Security Issues
 
-If you have encountered a potential security vulnerability in Zend Framework, please **DO NOT** report it on the public
+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.
 
@@ -29,61 +85,140 @@ When reporting issues, please provide the following information:
 - 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 Zend Framework users and provides them with a chance to upgrade and/or update in order to protect their applications.
+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).
 
-## RUNNING TESTS
+## Recommended Workflow for Contributions
 
-To run tests:
+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.
 
-- Clone the zf2 repository (or download it, if you do not have GIT installed):
+1. Setup a [GitHub account](http://github.com/), if you haven't yet
+2. Fork the repository (http://github.com/zendframework/zf2)
+3. Clone the canonical repository locally and enter it.
 
-  ```sh
-  % git clone git@github.com:zendframework/zf2.git
-  % cd
-  ```
+   ```console
+   $ git clone git://github.com:zendframework/zf2.git
+   $ cd zf2
+   ```
 
-- Install dependencies via composer:
+4. Add a remote to your fork; substitute your GitHub username in the command
+   below.
 
-  ```sh
-  % curl -sS https://getcomposer.org/installer | php --
-  % ./composer.phar install
-  ```
+   ```console
+   $ git remote add {username} git@github.com:{username}/zf2.git
+   $ git fetch {username}
+   ```
 
-  If you don't have `curl` installed, you can also download `composer.phar` from https://getcomposer.org/
+### Keeping Up-to-Date
 
-- Run the tests via `phpunit` and the provided PHPUnit config, like in this example:
+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:
 
-  ```sh
-  % ./../vendor/bin/phpunit -c tests/phpunit.xml.dist tests/ZendTest/Http
-  % ./../vendor/bin/phpunit -c tests/phpunit.xml.dist tests/ZendTest/Http/Header/EtagTest.php
-  ```
 
-  Note that the entire test suite is not designed to be run in a single pass.
-  Run tests for the single components instead. You can do it by using the `run-tests.php` utility provided
-  with the repository:
+```console
+$ git checkout master
+$ git fetch origin
+$ git rebase origin/master
+# OPTIONALLY, to keep your remote up-to-date -
+$ git push {username} master:master
+```
 
-  ```sh
-  % php run-tests.php
-  ```
+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".
 
-  You can also provide top-level component names to run tests for individual
-  components or several components at a time. The component name is the the
-  component namespace, without the `Zend\` prefix:
+### Working on a patch
 
-  ```sh
-  % php run-tests.php Mvc
-  ```
+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.
 
-  ```sh
-  % php run-tests.php ModuleManager Mvc View Navigation
-  ```
+A typical workflow will then consist of the following:
 
-You can turn on conditional tests with the TestConfiguration.php file.
-To do so:
+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.
 
- -  Enter the `tests/` subdirectory.
- -  Copy `TestConfiguration.php.dist` file to `TestConfiguration.php`
- -  Edit `TestConfiguration.php` to enable any specific functionality you
-    want to test, as well as to provide test values to utilize.
+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'
+```
+
+... do some work ...
+
+
+```console
+$ git commit
+```
+
+... 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://git@github.com/{username}/zf2.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
+"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
+
+#### 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>
+   ```
+
+-  Remote branch removal
+
+   ```console
+   $ git push {username} :<branchname>
+   ```
diff --git a/INSTALL.md b/INSTALL.md
@@ -1,14 +1,12 @@
 # INSTALLATION
 
-Zend Framework requires no special installation steps. Simply download
-the framework, extract it to the folder you would like to keep it in,
-and add the library directory to your PHP `include_path`.
-
+```console
+$ composer require zendframework/zendframework
+```
 
 ## SYSTEM REQUIREMENTS
--------------------
 
-Zend Framework 2 requires PHP 5.3.23 or later.
+Zend Framework 2 requires PHP 5.5 or later.
 
 ## DEVELOPMENT VERSIONS
 
@@ -28,28 +26,12 @@ Framework using one of the following methods:
 
 To clone the git repository, use the following URL:
 
-git://git.zendframework.com/zf.git
+https://github.com/zendframework/zf2.git
 
 For more information about Git, please see the official website:
 
 http://www.git-scm.org
 
-## CONFIGURING THE INCLUDE PATH
-
-Once you have a copy of Zend Framework available, your application will
-need to access the framework classes. Though there are several ways to
-achieve this, your PHP `include_path` needs to contain the path to the
-Zend Framework classes under the `/library` directory in this
-distribution. You can find out more about the PHP `include_path`
-configuration directive here:
-
-http://www.php.net/manual/en/ini.core.php#ini.include-path
-
-Instructions on how to change PHP configuration directives can be found
-here:
-
-http://www.php.net/manual/en/configuration.changes.php
-
 ## GETTING STARTED
 
 A great place to get up-to-speed quickly is the Zend Framework

diff --git a/LICENSE.txt → LICENSE.md b/LICENSE.txt → LICENSE.md
@@ -1,19 +1,18 @@
-Copyright (c) 2005-2015, Zend Technologies USA, Inc.
-All rights reserved.
+Copyright (c) 2005-2015, Zend Technologies USA, Inc.  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
-      software without specific prior written permission.
+- 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
+  software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED