wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-07-21 12:50:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

DOC: Update gitwash.

Browse Source
This commit is contained in:
Stefan van der Walt
2011-10-23 22:56:43 -07:00
parent 5ec4fdec09
commit d5120a16bc
9 changed files with 51 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/gitwash/development_workflow.txt
+8 -8
View File
@@ -4,14 +4,14 @@
Development workflow
####################
You already have your own forked copy of the scikits.image_ repository, by
You already have your own forked copy of the scikits-image_ repository, by
following :ref:`forking`. You have :ref:`set-up-fork`. You have configured
git by following :ref:`configure-git`. Now you are ready for some real work.
Workflow summary
================
In what follows we'll refer to the upstream scikits.image ``master`` branch, as
In what follows we'll refer to the upstream scikits-image ``master`` branch, as
"trunk".
* Don't use your ``master`` branch for anything. Consider deleting it.
@@ -24,7 +24,7 @@ In what follows we'll refer to the upstream scikits.image ``master`` branch, as
* If you can possibly avoid it, avoid merging trunk or any other branches into
your feature branch while you are working.
* If you do find yourself merging from trunk, consider :ref:`rebase-on-trunk`
* Ask on the `scikits.image mailing list`_ if you get stuck.
* Ask on the `scikits-image mailing list`_ if you get stuck.
* Ask for code review!
This way of working helps to keep work well organized, with readable history.
@@ -81,7 +81,7 @@ what the changes in the branch are for. For example ``add-ability-to-fly``, or
git checkout my-new-feature
Generally, you will want to keep your feature branches on your public github_
fork of scikits.image_. To do this, you `git push`_ this new branch up to your
fork of scikits-image_. To do this, you `git push`_ this new branch up to your
github repo. Generally (if you followed the instructions in these pages, and by
default), git will have a link to your github repo, called ``origin``. You push
up to your own repo on github with::
@@ -150,7 +150,7 @@ Ask for your changes to be reviewed or merged
When you are ready to ask for someone to review your code and consider a merge:
#. Go to the URL of your forked repo, say
``http://github.com/your-user-name/scikits.image``.
``http://github.com/your-user-name/scikits-image``.
#. Use the 'Switch Branches' dropdown menu near the top left of the page to
select the branch with your changes:
@@ -192,10 +192,10 @@ If you want to work on some stuff with other people, where you are all
committing into the same repository, or even the same branch, then just
share it via github.
First fork scikits.image into your account, as from :ref:`forking`.
First fork scikits-image into your account, as from :ref:`forking`.
Then, go to your forked repository github page, say
``http://github.com/your-user-name/scikits.image``
``http://github.com/your-user-name/scikits-image``
Click on the 'Admin' button, and add anyone else to the repo as a
collaborator:
@@ -204,7 +204,7 @@ collaborator:
Now all those people can do::
git clone git@githhub.com:your-user-name/scikits.image.git
git clone git@githhub.com:your-user-name/scikits-image.git
Remember that links starting with ``git@`` use the ssh protocol and are
read-write; links starting with ``git://`` are read-only.
doc/source/gitwash/following_latest.txt
+6 -6
View File
@@ -5,12 +5,12 @@
=============================
These are the instructions if you just want to follow the latest
*scikits.image* source, but you don't need to do any development for now.
*scikits-image* source, but you don't need to do any development for now.
The steps are:
* :ref:`install-git`
* get local copy of the `scikits.image github`_ git repository
* get local copy of the `scikits-image github`_ git repository
* update local copy from time to time
Get the local copy of the code
@@ -18,19 +18,19 @@ Get the local copy of the code
From the command line::
git clone git://github.com/scikits-image/scikits.image.git
git clone git://github.com/scikits-image/scikits-image.git
You now have a copy of the code tree in the new ``scikits.image`` directory.
You now have a copy of the code tree in the new ``scikits-image`` directory.
Updating the code
=================
From time to time you may want to pull down the latest code. Do this with::
cd scikits.image
cd scikits-image
git pull
The tree in ``scikits.image`` will now have the latest changes from the initial
The tree in ``scikits-image`` will now have the latest changes from the initial
repository.
.. include:: links.inc
doc/source/gitwash/forking_hell.txt
+5 -5
View File
@@ -1,13 +1,13 @@
.. _forking:
==========================================
Making your own copy (fork) of scikits.image
Making your own copy (fork) of scikits-image
==========================================
You need to do this only once. The instructions here are very similar
to the instructions at http://help.github.com/forking/ |emdash| please see
that page for more detail. We're repeating some of it here just to give the
specifics for the scikits.image_ project, and to suggest some default names.
specifics for the scikits-image_ project, and to suggest some default names.
Set up and configure a github account
=====================================
@@ -17,17 +17,17 @@ If you don't have a github account, go to the github page, and make one.
You then need to configure your account to allow write access |emdash| see
the ``Generating SSH keys`` help on `github help`_.
Create your own forked copy of scikits.image_
Create your own forked copy of scikits-image_
===========================================
#. Log into your github account.
#. Go to the scikits.image_ github home at `scikits.image github`_.
#. Go to the scikits-image_ github home at `scikits-image github`_.
#. Click on the *fork* button:
.. image:: forking_button.png
Now, after a short pause and some 'Hardcore forking action', you
should find yourself at the home page for your own forked copy of scikits.image_.
should find yourself at the home page for your own forked copy of scikits-image_.
.. include:: links.inc
doc/source/gitwash/git_intro.txt
+2 -2
View File
@@ -2,11 +2,11 @@
Introduction
==============
These pages describe a git_ and github_ workflow for the scikits.image_
These pages describe a git_ and github_ workflow for the scikits-image_
project.
There are several different workflows here, for different ways of
working with *scikits.image*.
working with *scikits-image*.
This is not a comprehensive git reference, it's just a workflow for our
own project. It's tailored to the github hosting service. You may well
doc/source/gitwash/index.txt
+1 -1
View File
@@ -1,6 +1,6 @@
.. _using-git:
Working with *scikits.image* source code
Working with *scikits-image* source code
======================================
Contents:
doc/source/gitwash/maintainer_workflow.txt
+2 -2
View File
@@ -16,7 +16,7 @@ access to the upstream repo. Being a maintainer, you've got read-write access.
It's good to have your upstream remote have a scary name, to remind you that
it's a read-write remote::
git remote add upstream-rw git@github.com:scikits-image/scikits.image.git
git remote add upstream-rw git@github.com:scikits-image/scikits-image.git
git fetch upstream-rw
*******************
@@ -29,7 +29,7 @@ Let's say you have some changes that need to go into trunk
The changes are in some branch that you are currently on. For example, you are
looking at someone's changes like this::
git remote add someone git://github.com/someone/scikits.image.git
git remote add someone git://github.com/someone/scikits-image.git
git fetch someone
git branch cool-feature --track someone/cool-feature
git checkout cool-feature
doc/source/gitwash/patching.txt
+10 -10
View File
@@ -3,7 +3,7 @@
================
You've discovered a bug or something else you want to change
in scikits.image_ .. |emdash| excellent!
in scikits-image_ .. |emdash| excellent!
You've worked out a way to fix it |emdash| even better!
@@ -29,9 +29,9 @@ Overview
git config --global user.email you@yourdomain.example.com
git config --global user.name "Your Name Comes Here"
# get the repository if you don't have it
git clone git://github.com/scikits-image/scikits.image.git
git clone git://github.com/scikits-image/scikits-image.git
# make a branch for your patching
cd scikits.image
cd scikits-image
git branch the-fix-im-thinking-of
git checkout the-fix-im-thinking-of
# hack, hack, hack
@@ -44,7 +44,7 @@ Overview
# make the patch files
git format-patch -M -C master
Then, send the generated patch files to the `scikits.image
Then, send the generated patch files to the `scikits-image
mailing list`_ |emdash| where we will thank you warmly.
In detail
@@ -57,10 +57,10 @@ In detail
git config --global user.name "Your Name Comes Here"
#. If you don't already have one, clone a copy of the
scikits.image_ repository::
scikits-image_ repository::
git clone git://github.com/scikits-image/scikits.image.git
cd scikits.image
git clone git://github.com/scikits-image/scikits-image.git
cd scikits-image
#. Make a 'feature branch'. This will be where you work on
your bug fix. It's nice and safe and leaves you with
@@ -100,7 +100,7 @@ In detail
0001-BF-added-tests-for-Funny-bug.patch
0002-BF-added-fix-for-Funny-bug.patch
Send these files to the `scikits.image mailing list`_.
Send these files to the `scikits-image mailing list`_.
When you are done, to switch back to the main copy of the
code, just return to the ``master`` branch::
@@ -115,7 +115,7 @@ more feature branches, you will probably want to switch to
development mode. You can do this with the repository you
have.
Fork the scikits.image_ repository on github |emdash| :ref:`forking`.
Fork the scikits-image_ repository on github |emdash| :ref:`forking`.
Then::
# checkout and refresh master branch from main repo
@@ -124,7 +124,7 @@ Then::
# rename pointer to main repository to 'upstream'
git remote rename origin upstream
# point your repo to default read / write to your fork on github
git remote add origin git@github.com:your-user-name/scikits.image.git
git remote add origin git@github.com:your-user-name/scikits-image.git
# push up any branches you've made and want to keep
git push origin the-fix-im-thinking-of
doc/source/gitwash/set_up_fork.txt
+13 -13
View File
@@ -11,9 +11,9 @@ Overview
::
git clone git@github.com:your-user-name/scikits.image.git
cd scikits.image
git remote add upstream git://github.com/scikits-image/scikits.image.git
git clone git@github.com:your-user-name/scikits-image.git
cd scikits-image
git remote add upstream git://github.com/scikits-image/scikits-image.git
In detail
=========
@@ -22,8 +22,8 @@ Clone your fork
---------------
#. Clone your fork to the local computer with ``git clone
git@github.com:your-user-name/scikits.image.git``
#. Investigate. Change directory to your new repo: ``cd scikits.image``. Then
git@github.com:your-user-name/scikits-image.git``
#. Investigate. Change directory to your new repo: ``cd scikits-image``. Then
``git branch -a`` to show you all branches. You'll get something
like::
@@ -35,7 +35,7 @@ Clone your fork
What remote repository is ``remote/origin``? Try ``git remote -v`` to
see the URLs for the remote. They will point to your github fork.
Now you want to connect to the upstream `scikits.image github`_ repository, so
Now you want to connect to the upstream `scikits-image github`_ repository, so
you can merge in changes from trunk.
.. _linking-to-upstream:
@@ -45,11 +45,11 @@ Linking your repository to the upstream repo
::
cd scikits.image
git remote add upstream git://github.com/scikits-image/scikits.image.git
cd scikits-image
git remote add upstream git://github.com/scikits-image/scikits-image.git
``upstream`` here is just the arbitrary name we're using to refer to the
main scikits.image_ repository at `scikits.image github`_.
main scikits-image_ repository at `scikits-image github`_.
Note that we've used ``git://`` for the URL rather than ``git@``. The
``git://`` URL is read only. This means we that we can't accidentally
@@ -59,10 +59,10 @@ use it to merge into our own code.
Just for your own satisfaction, show yourself that you now have a new
'remote', with ``git remote -v show``, giving you something like::
upstream git://github.com/scikits-image/scikits.image.git (fetch)
upstream git://github.com/scikits-image/scikits.image.git (push)
origin git@github.com:your-user-name/scikits.image.git (fetch)
origin git@github.com:your-user-name/scikits.image.git (push)
upstream git://github.com/scikits-image/scikits-image.git (fetch)
upstream git://github.com/scikits-image/scikits-image.git (push)
origin git@github.com:your-user-name/scikits-image.git (fetch)
origin git@github.com:your-user-name/scikits-image.git (push)
.. include:: links.inc
doc/source/gitwash/this_project.inc
+4 -4
View File
@@ -1,5 +1,5 @@
.. scikits.image
.. _scikits.image: http://scikits-image.org
.. _`scikits.image github`: http://github.com/scikits-image/scikits.image
.. scikits-image
.. _scikits-image: http://scikits-image.org
.. _`scikits-image github`: http://github.com/scikits-image/scikits-image
.. _`scikits.image mailing list`: http://groups.google.com/group/scikits-image
.. _`scikits-image mailing list`: http://groups.google.com/group/scikits-image