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

Commit

Permalink
Updated README files
Browse files Browse the repository at this point in the history 
- Provided detailed Git instructions
- Rewrote README-DEV.txt to discuss how to contribute
- Updated README.txt to reflect status of ZF2
  • Loading branch information
@weierophinney
weierophinney committed Jul 21, 2010
1 parent 2c8e4ac commit fbde290
Show file tree
Hide file tree
Showing 3 changed files with 206 additions and 116 deletions.
109 changes: 24 additions & 85 deletions README-DEV.txt
View file
Original file line number Diff line number Diff line change
@@ -1,93 +1,32 @@
During the namespace conversion, do the following:
If you wish to contribute to Zend Framework, please be sure to
read/subscribe to the following resources:

% cd working
% php ../tools/phptools/bin/php-namespacer.php \
> -m./ -l=../library/ -p=Zend -o=./tmp/library -d=Zend/<component name>
* ZF2 Requirements:
http://framework.zend.com/wiki/display/ZFDEV2/Zend+Framework+2.0+Requirements

Check the changes, and merge them into the trunk. Then make the unit
tests pass.
* Coding Standards:
http://framework.zend.com/manual/en/coding-standard.html

Checklist:
First pass
[X] Zend_Exception
[X] Zend_Version
[X] Zend_Loader
[X] Including pluginloader, resource loader, etc.
[X] Zend_Registry
[X] Zend_Config
[X] Zend_Debug
[X] Zend_Log
Would need to ignore Firebug writer for now, and potentially Db writer
[X] Zend_Cache
[X] Zend_Locale
[X] Zend_Date
[X] Zend_Translate
[X] Zend_TimeSync
[X] Zend_Measure
[X] Zend_Currency
* ZF Git Guide:
README-GIT.txt

Second pass:
[X] Zend_Filter
skip Input at first
[X] Zend_Validate
skip Validate_Db at first
do [X] Zend_Filter_Input at this time
[X] Zend_Uri
* Contributor's Guide:
http://framework.zend.com/wiki/display/ZFDEV/Contributing+to+Zend+Framework

Third pass:
[X] Zend_Server
[X] Zend_Http
* ZF Contributor's mailing list:
Archives: http://short.ie/tc64rv
Subscribe: zf-contributors-subscribe@lists.zend.com

Fourth pass:
THE FOLLOWING IN ANY ORDER (except where indicated):
[X] Zend_Json
[X] Zend_Crypt
[X] `-> Zend_Oauth
[X] `-> Zend_XmlRpc
[X] Zend_Acl
[X] Zend_Reflection
[X] Zend_CodeGenerator
[X] Zend_Console
[X] Zend_Dom
[X] Zend_Gdata
[X] Zend_InfoCard
[X] Zend_Ldap
[X] Zend_Mime
[X] `-> Zend_Mail
[X] Zend_Markup
[X] Zend_Memory
[X] `-> Zend_Pdf
[X] `-> Zend_Barcode
[X] Zend_Db (except Firebug profiler)
[X] `-> Zend_Feed
[X] `-> Zend_Queue
[X] Zend_Text
[X] `-> Zend_ProgressBar
[X] `-> Zend_File
[X] Zend_Search
[X] Zend_Service_Abstract
[X] `-> Zend_Rest_Client
[X] `-> Zend_Service_ReCaptcha
[X] `-> Zend_Captcha
[X] Zend_Soap
[X] Zend_Tag
[ ] Zend_Service_*
[X] Zend_Session
[X] `-> Zend_Auth
[X] `-> Zend_Amf
[X] `-> Zend_Serializer
* ZF Contributor's IRC channel:
#zftalk.dev on Freenode.net

Fifth pass:
All together:
[X] Zend_Controller, [X] Zend_View, [X] Zend_Layout, [X] Zend_Rest_Route/Controller
In order to contribute, you MUST first sign and send in a Contributor's
License Agreement; you may obtain a copy from
http://framework.zend.com/cla (individuals) or
http://framework.zend.com/ccla (corporate); please read the
contributor's guide, linked above, for more information on the CLA and
how to deliver it.

Sixth pass:
[X] Zend_Wildfire (and all Firebug related sub-components)
[X] Zend_OpenId
[X] Zend_Form -> [ ] Zend_Dojo
[X] Zend_Navigation
[X] Zend_Paginator
[ ] Zend_Test

Seventh (and last) pass:
[X] Zend_Application -> [X] Zend_Tool
If you are working on new features, or refactoring an existing
component, please create a proposal. You can do this in on the proposals
page, http://framework.zend.com/wiki/display/ZFPROP/Home.
191 changes: 174 additions & 17 deletions README-GIT.txt
View file
Original file line number Diff line number Diff line change
@@ -1,29 +1,186 @@
CLONING THE REPOSITORY
======================
Anonymous cloning may be done from:
USING THE GIT REPOSITORY
========================

git://git.zendframework.com/zf.git
Initial Setup
-------------

If you have commit rights, you will use the following:
First, make sure you know the email address associated with your JIRA
credentials. All commits pushed to the master repository are checked
against these addresses, so your repository will need to be configured
to use that address. The following will give you that information:

ssh://git@git.zendframework.com:21652/zf.git
* Visit the ZF Crowd install: http://framework.zend.com/crowd

You must make sure your author email is specified exactly as it appears
in JIRA. To do so, do the following in your git repository:
* Log in, if you aren't.

git config user.email <your email address>
* Find the "My Profile" link in the upper right of the page, and follow
it.

If it does not match, any commits made with you as an author will be
rejected.
* The resulting page will display your profile, including the _email_
address with which you are registered. Make a note of it.

If you are unsure of what email address is tied to your JIRA account,
visit the following site:
Setup your own public repository
--------------------------------

http://framework.zend.com/crowd
Your next step is to establish a public repository from which we can
pull your work into the master repository. You have two options: use
github or other public site, or setup/use your own repository.

Option 1: GitHub
----------------

* Setup a GitHub account (http://github.com/), if you haven't yet

* Fork the ZF2 respository (http://github.com/zendframework/zf2)

* Clone your fork locally and enter it (use your own GitHub username
in the statement below)

% git clone git@github.com:<username>/zf2.git
% cd zf2

* Configure git to use the email address with which you are registered
in JIRA:

% git config user.email <your email address>

* Add a remote to the canonical ZF repository (or GitHub mirror), so
you can keep your fork up-to-date:

% git remote add zf2 git://github.com/zendframework/zf2.git
- OR -
% git remote add zf2 git://zendframework.com/zf2.git
- AND -
% git fetch zf2

Option 2: Personal Repository
-----------------------------

We assume you will use gitosis (http://short.e/m6t2pn) or gitolite
(http://progit.org/book/ch4-8.html) to host your own repository. If
you go this route, we will assume you have the knowledge to do so, or
know where to obtain it. We will not assist you in setting up such a
repository.

* Create a new repository

% git init

* Configure git to use the email address with which you are registered
in JIRA:

% git config user.email <your email address>

* Add an "origin" remote pointing to your gitosis/gitolite repo:

% git remote add origin git://yourdomain/yourrepo.git

* Add a remote for the ZF repository and fetch it

% git remote add zf2 git://zendframework.com/zf2.git
% git fetch zf2

* Create a new branch for the ZF repository (named "zf/master" here)

% git branch -b zf/master zf2/master

* Create your master branch off the ZF branch, and push to your
repository

% git branch -b master
% git push origin HEAD:master

Keeping Up-to-Date
------------------

Periodically, you should update your fork or personal repository to
match the canonical ZF repository. In each of the above setups, we have
added a remote to the Zend Framework repository, which allows you to do
the following:


% git checkout master
% git pull zf2 master
- OPTIONALLY, to keep your remote up-to-date -
% git push origin

Working on Zend Framework
-------------------------

When working on Zend Framework, we recommend you do each new feature or
bugfix in a new branch. This simplifies the task of code review as well
as of merging your changes into the canonical repository.

A typical work flow will then consist of the following:

* Create a new local branch based off your master branch.

* Switch to your new local branch. (This step can be combined with the
previous step with the use of "git checkout -b".)

* Do some work, commit, repeat as necessary.

* Push the local branch to your remote repository.

* 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.

% git checkout -b zf9295
Switched to a new branch 'zf9295'

... do some work ...

% git commit

... write your log message ...

% git push origin HEAD:zf9295
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/weierophinney/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
"zendframework" as the recipient.

If using your own repository - or even if using GitHub - you can send an
email indicating you have changes to pull:

* Send to mailto:zf-devteam@zend.com

* In your message, specify:
* The URL to your repository (e.g., "git://mwop.net/zf2.git")
* The branch containing the changes you want pulled (e.g., "zf9295")
* The nature of the changes (e.g., "implements
Zend_Service_Twitter", "fixes ZF-9295", etc.)

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

% git branch -d <branchname>

* Remote branch removal

% git push origin :<branchname>

and log in with your JIRA credentials. Click the "My Profile" link in
the upper right corner of the page. You will then see your email address
listed.

FEEDS AND EMAILS
================
Expand Down
22 changes: 8 additions & 14 deletions README.txt
View file
Original file line number Diff line number Diff line change
@@ -1,29 +1,23 @@
Welcome to the Zend Framework 1.10 Release!
Welcome to the Zend Framework 2.0.0 Release!

RELEASE INFORMATION
---------------
Zend Framework 1.10dev Release ([INSERT REV NUM HERE]).
Released on <Month> <Day>, <Year>.
Zend Framework 2.0.0dev1

THIS RELEASE IS A DEVELOPMENT RELEASE AND NOT INTENDED FOR PRODUCTION USE.
PLEASE USE AT YOUR OWN RISK.

NEW FEATURES
------------

* Zend_Filter_Null, contributed by Thomas Weidner
* Zend_Filter_Compress/Decompress, contributed by Thomas Weidner
* Zend_Validate_Callback, contributed by Thomas Weidner
* Zend_Validate_PostCode, contributed by Thomas Weidner

A detailed list of all features and bug fixes in this release may be found at:
Please see the ZF2 Requirements page for details on new features and changes:

http://framework.zend.com/changelog/
http://framework.zend.com/wiki/display/ZFDEV2/Zend+Framework+2.0+Requirements

SYSTEM REQUIREMENTS
-------------------

Zend Framework requires PHP 5.2.4 or later. Please see our reference
guide for more detailed system requirements:

http://framework.zend.com/manual/en/requirements.html
Zend Framework 2 requires PHP 5.3 or later.

INSTALLATION
------------
Expand Down

0 comments on commit fbde290

Please sign in to comment.