diff --git a/html/contributing.php b/html/contributing.php index 4e77fa9e..ec2c4a49 100644 --- a/html/contributing.php +++ b/html/contributing.php @@ -18,23 +18,41 @@ git clone git://github.com/derickr/xdebug.git

-If you think you want to fix a bug, then you need to following the following things. +If you think you want to fix a bug or work on a new feature, then you +need to following the following things.

- +

Initial Set-up

  1. Fork Xdebug on github.
    2. -
  2. Clone the repository: git clone git@github.com:{your username}/xdebug.git, for example: git clone git@github.com:derickr/xdebug.git.
    3. -
  3. Change into the xdebug repository: cd xdebug.
    4. -
  4. Add the original repository as remote: git remote add xdebug git://github.com/derickr/xdebug.git && git fetch xdebug.
    5. +
  5. Clone the repository:
    + git clone git@github.com:{your username}/xdebug.git
    + for example:
    + git clone git@github.com:derickr/xdebug.git +
    6. +
  6. Change into the xdebug repository:
    + cd xdebug. +
    7. +
  7. Make sure to set your git name and email:
    + git config --get user.name && git config --get user.email
    + If they are not correct, set them to the correct value:
    + git config user.name {your name} && git config user.email {your email}
    + for example:
    + git config user.name "Derick Rethans" && git config user.email "derick@xdebug.org" +
    8. +
  8. Add the original repository as remote:
    + git remote add xdebug git://github.com/derickr/xdebug.git && git fetch xdebug +
- +

Keeping up-to-date

    -
  1. Change into the xdebug repository (if you haven't done yet): cd xdebug.
    2. -
  2. Run: git checkout master && git pull xdebug master.
    3. -
  3. Run: git checkout xdebug_2_1 && git pull xdebug xdebug_2_1.
    4. +
  4. Change into the xdebug repository (if you haven't done yet):
    + cd xdebug +
    5. +
  5. Run:
    git checkout master && git pull xdebug master
    6. +
  6. Run:
    git checkout xdebug_2_1 && git pull xdebug xdebug_2_1
@@ -44,10 +62,12 @@ master.

  1. First of all, make sure you're up-to-date.
    2. -
  2. Checkout the xdebug_2_1 branch: git checkout xdebug_2_1.
    3. -
  3. Create a feature branch: git checkout -b - issue{issue number}, for example: git checkout -b - issue681. If there is no +
  4. Checkout the xdebug_2_1 branch:
    git checkout xdebug_2_1.
    5. +
  5. Create a feature branch:
    + git checkout -b issue{issue number}
    + for example:
    + git checkout -b issue681
    + If there is no bug report yet, then you need to create one. If you want, you can add a description of the feature after the issue681 part, for example: @@ -58,11 +78,12 @@
  6. Commit it to your local repository: git commit ...
  7. Repeat the previous two steps as long as you want.
  8. Bring things up-to-date with the original repository, especially important - if it took some time since you branched: git fetch xdebug && git - rebase xdebug/xdebug_2_1.
    9. -
  9. Push your changes to your remote repository: git push origin - {issue number}:{issue number}, for example: - git push origin issue681:issue681.
    10. + if it took some time since you branched:
    + git fetch xdebug && git rebase xdebug/xdebug_2_1 +
  10. Push your changes to your remote repository:
    + git push origin {issue number}:{issue number}
    + for example:
    + git push origin issue681:issue681

  11. Once you're satisfied, generate a pull request, by navigating to your repository (https://github.com/{username}/xdebug), select @@ -81,10 +102,12 @@ xdebug_2_1.

    1. First of all, make sure you're up-to-date.
      2. -
    2. Checkout the master branch: git checkout master.
      3. -
    3. Create a feature branch: git checkout -b - issue{issue number}, for example: git checkout -b - issue681. If there is no +
    4. Checkout the master branch:
      git checkout master.
      5. +
    5. Create a feature branch:
      + git checkout -b issue{issue number}
      + for example:
      + git checkout -b issue681
      + If there is no bug report yet, then you need to create one. If you want, you can add a description of the feature after the issue681 part, for example: @@ -95,11 +118,12 @@
    6. Commit it to your local repository: git commit ...
    7. Repeat the previous two steps as long as you want.
    8. Bring things up-to-date with the original repository, especially important - if it took some time since you branched: git fetch xdebug && git - rebase xdebug/master.
      9. -
    9. Push your changes to your remote repository: git push origin - {issue number}:{issue number}, for example: - git push origin issue681:issue681.
      10. + if it took some time since you branched:
      + git fetch xdebug && git rebase xdebug/master +
    10. Push your changes to your remote repository:
      + git push origin {issue number}:{issue number}
      + for example:
      + git push origin issue681:issue681

    11. Once you're satisfied, generate a pull request, by navigating to your repository (https://github.com/{username}/xdebug), select