Skip to content

Latest commit

 

History

History
278 lines (208 loc) · 7.64 KB

README-GIT.md

File metadata and controls

278 lines (208 loc) · 7.64 KB
Raw

USING THE GIT REPOSITORY

Setup your own public repository

Your first 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.

While you can use a private repository and utilize git format-patch to submit patches, this is discouraged as it does not facilitate public peer review.

Option 1: GitHub

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

  2. Fork the ZF2 repository (http://github.com/zendframework/zf2)

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

    % git clone [email protected]:<username>/zf2.git
% cd zf2

  4. Add a remote to the canonical ZF repository, so you can keep your fork up-to-date:

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

Option 2: Personal Repository

We assume you will use gitosis (http://git-scm.com/book/en/Git-on-the-Server-Gitosis) or gitolite (http://git-scm.com/book/en/Git-on-the-Server-Gitolite) 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.

  1. Create a new repository
```sh
% git init
```

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

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

  2. Add a remote for the ZF repository and fetch it

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

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

    % git checkout -b zf/master zf2/master

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

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

Pre-Commit Hook (Optional)

The ZF2 Travis-CI will confirm that code style standards are met by using php-cs-fixer (https://github.com/fabpot/PHP-CS-Fixer) during it's build runs.

To reduce the number of red Travis-CI builds, the following Git pre-commit hook can help catch code style issues before committing. Save it as .git/hooks/pre-commit, and make sure it is executable.

#!/usr/bin/env php
<?php
/**
 * .git/hooks/pre-commit
 * 
 * This pre-commit hooks will check for PHP errors (lint), and make sure the 
 * code is PSR-2 compliant.
 * 
 * Dependecy: PHP-CS-Fixer (https://github.com/fabpot/PHP-CS-Fixer)
 * 
 * @author  Mardix  http://github.com/mardix 
 * @author  Matthew Weier O'Phinney http://mwop.net/
 * @since   4 Sept 2012
 */

$exit = 0;

/*
 * collect all files which have been added, copied or
 * modified and store them in an array called output
 */
$output = array();
exec('git diff --cached --name-status --diff-filter=ACM', $output);

foreach ($output as $file) {
    if ('D' === substr($file, 0, 1)) {
        // deleted file; do nothing
        continue;
    }

    $fileName = trim(substr($file, 1));

    /*
     * Only PHP files
     */
    $extension = pathinfo($fileName, PATHINFO_EXTENSION);
    if (!preg_match('/^ph(p|tml)$/', $extension)) {
        continue;
    }

    /*
     * Check for parse errors
     */
    $output = array();
    $return = 0;
    exec("php -l " . escapeshellarg($fileName), $output, $return);

    if ($return != 0) {
        echo "PHP file fails to parse: " . $fileName . ":" . PHP_EOL;
        echo implode(PHP_EOL, $lintOutput) . PHP_EOL;
        $exit = 1;
        continue;
    }

    /*
     * PHP-CS-Fixer
     */
    $output = array();
    $return = null;
    exec("php-cs-fixer fix --dry-run --level=psr2 " . escapeshellarg($fileName), $output, $return);
    if ($return != 0 || !empty($output)) {
        echo "PHP file fails contains CS issues: " . $fileName . ":" . PHP_EOL;
        echo implode(PHP_EOL, $output) . PHP_EOL;
        $exit = 1;
        continue;
    }
}

exit($exit);

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

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 substibute "develop" for "master".

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:

  1. Create a new local branch based off your master 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.

% 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://[email protected]/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 [email protected]

  • 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.)

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

    % git branch -d <branchname>

  • Remote branch removal

    % git push origin :<branchname>

FEEDS AND EMAILS

RSS feeds may be found at:

https://github.com/zendframework/zf2/commits/<branch>.atom

where <branch> is a branch in the repository.

To subscribe to git email notifications, simply watch or fork the zf2 repository on GitHub.

CONTRIBUTORS AND COMMITTERS

Both Zend's internal Zend Framework team and the members of the Community Review team have push privileges to the ZF2 repository.