mirror of
https://github.com/wassname/scikit-image.git
synced 2026-07-05 19:41:25 +08:00
Updated the gitwash build.
This commit is contained in:
@@ -4,7 +4,7 @@
|
||||
Development workflow
|
||||
####################
|
||||
|
||||
You already have your own forked copy of the scikit-image_ repository, by
|
||||
You already have your own forked copy of the `scikit-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.
|
||||
|
||||
@@ -22,7 +22,7 @@ In what follows we'll refer to the upstream scikit-image ``master`` branch, as
|
||||
* Name your branch for the purpose of the changes - e.g.
|
||||
``bugfix-for-issue-14`` or ``refactor-database-code``.
|
||||
* If you can possibly avoid it, avoid merging trunk or any other branches into
|
||||
your feature branch while you are working.
|
||||
your feature branch while you are working.
|
||||
* If you do find yourself merging from trunk, consider :ref:`rebase-on-trunk`
|
||||
* Ask on the `scikit-image mailing list`_ if you get stuck.
|
||||
* Ask for code review!
|
||||
@@ -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 scikit-image_. To do this, you `git push`_ this new branch up to your
|
||||
fork of `scikit-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::
|
||||
|
||||
@@ -1,33 +1,33 @@
|
||||
.. _forking:
|
||||
|
||||
============================================
|
||||
======================================================
|
||||
Making your own copy (fork) of scikit-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 scikit-image_ project, and to suggest some default names.
|
||||
specifics for the `scikit-image`_ project, and to suggest some default names.
|
||||
|
||||
Set up and configure a github account
|
||||
======================================
|
||||
=====================================
|
||||
|
||||
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 scikit-image_
|
||||
=============================================
|
||||
Create your own forked copy of `scikit-image`_
|
||||
======================================================
|
||||
|
||||
#. Log into your github account.
|
||||
#. Go to the scikit-image_ github home at `scikit-image github`_.
|
||||
#. Go to the `scikit-image`_ github home at `scikit-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 scikit-image_.
|
||||
should find yourself at the home page for your own forked copy of `scikit-image`_.
|
||||
|
||||
.. include:: links.inc
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Overview
|
||||
========
|
||||
|
||||
================ =============
|
||||
Debian / Ubuntu ``sudo apt-get install git-core``
|
||||
Debian / Ubuntu ``sudo apt-get install git``
|
||||
Fedora ``sudo yum install git-core``
|
||||
Windows Download and install msysGit_
|
||||
OS X Use the git-osx-installer_
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Introduction
|
||||
==============
|
||||
|
||||
These pages describe a git_ and github_ workflow for the scikit-image_
|
||||
These pages describe a git_ and github_ workflow for the `scikit-image`_
|
||||
project.
|
||||
|
||||
There are several different workflows here, for different ways of
|
||||
|
||||
@@ -20,27 +20,27 @@
|
||||
.. _git svn crash course: http://git-scm.com/course/svn.html
|
||||
.. _learn.github: http://learn.github.com/
|
||||
.. _network graph visualizer: http://github.com/blog/39-say-hello-to-the-network-graph-visualizer
|
||||
.. _git user manual: http://www.kernel.org/pub/software/scm/git/docs/user-manual.html
|
||||
.. _git tutorial: http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html
|
||||
.. _git user manual: http://schacon.github.com/git/user-manual.html
|
||||
.. _git tutorial: http://schacon.github.com/git/gittutorial.html
|
||||
.. _git community book: http://book.git-scm.com/
|
||||
.. _git ready: http://www.gitready.com/
|
||||
.. _git casts: http://www.gitcasts.com/
|
||||
.. _Fernando's git page: http://www.fperez.org/py4science/git.html
|
||||
.. _git magic: http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html
|
||||
.. _git concepts: http://www.eecs.harvard.edu/~cduan/technical/git/
|
||||
.. _git clone: http://www.kernel.org/pub/software/scm/git/docs/git-clone.html
|
||||
.. _git checkout: http://www.kernel.org/pub/software/scm/git/docs/git-checkout.html
|
||||
.. _git commit: http://www.kernel.org/pub/software/scm/git/docs/git-commit.html
|
||||
.. _git push: http://www.kernel.org/pub/software/scm/git/docs/git-push.html
|
||||
.. _git pull: http://www.kernel.org/pub/software/scm/git/docs/git-pull.html
|
||||
.. _git add: http://www.kernel.org/pub/software/scm/git/docs/git-add.html
|
||||
.. _git status: http://www.kernel.org/pub/software/scm/git/docs/git-status.html
|
||||
.. _git diff: http://www.kernel.org/pub/software/scm/git/docs/git-diff.html
|
||||
.. _git log: http://www.kernel.org/pub/software/scm/git/docs/git-log.html
|
||||
.. _git branch: http://www.kernel.org/pub/software/scm/git/docs/git-branch.html
|
||||
.. _git remote: http://www.kernel.org/pub/software/scm/git/docs/git-remote.html
|
||||
.. _git rebase: http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html
|
||||
.. _git config: http://www.kernel.org/pub/software/scm/git/docs/git-config.html
|
||||
.. _git clone: http://schacon.github.com/git/git-clone.html
|
||||
.. _git checkout: http://schacon.github.com/git/git-checkout.html
|
||||
.. _git commit: http://schacon.github.com/git/git-commit.html
|
||||
.. _git push: http://schacon.github.com/git/git-push.html
|
||||
.. _git pull: http://schacon.github.com/git/git-pull.html
|
||||
.. _git add: http://schacon.github.com/git/git-add.html
|
||||
.. _git status: http://schacon.github.com/git/git-status.html
|
||||
.. _git diff: http://schacon.github.com/git/git-diff.html
|
||||
.. _git log: http://schacon.github.com/git/git-log.html
|
||||
.. _git branch: http://schacon.github.com/git/git-branch.html
|
||||
.. _git remote: http://schacon.github.com/git/git-remote.html
|
||||
.. _git rebase: http://schacon.github.com/git/git-rebase.html
|
||||
.. _git config: http://schacon.github.com/git/git-config.html
|
||||
.. _why the -a flag?: http://www.gitready.com/beginner/2009/01/18/the-staging-area.html
|
||||
.. _git staging area: http://www.gitready.com/beginner/2009/01/18/the-staging-area.html
|
||||
.. _tangled working copy problem: http://tomayko.com/writings/the-thing-about-git
|
||||
@@ -50,7 +50,7 @@
|
||||
.. _git foundation: http://matthew-brett.github.com/pydagogue/foundation.html
|
||||
.. _deleting master on github: http://matthew-brett.github.com/pydagogue/gh_delete_master.html
|
||||
.. _rebase without tears: http://matthew-brett.github.com/pydagogue/rebase_without_tears.html
|
||||
.. _resolving a merge: http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#resolving-a-merge
|
||||
.. _resolving a merge: http://schacon.github.com/git/user-manual.html#resolving-a-merge
|
||||
.. _ipython git workflow: http://mail.scipy.org/pipermail/ipython-dev/2010-October/006746.html
|
||||
|
||||
.. other stuff
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _using-git:
|
||||
|
||||
Working with *scikit-image* source code
|
||||
========================================
|
||||
================================================
|
||||
|
||||
Contents:
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
================
|
||||
|
||||
You've discovered a bug or something else you want to change
|
||||
in scikit-image_ .. |emdash| excellent!
|
||||
in `scikit-image`_ .. |emdash| excellent!
|
||||
|
||||
You've worked out a way to fix it |emdash| even better!
|
||||
|
||||
@@ -57,7 +57,7 @@ In detail
|
||||
git config --global user.name "Your Name Comes Here"
|
||||
|
||||
#. If you don't already have one, clone a copy of the
|
||||
scikit-image_ repository::
|
||||
`scikit-image`_ repository::
|
||||
|
||||
git clone git://github.com/scikit-image/scikit-image.git
|
||||
cd scikit-image
|
||||
@@ -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 scikit-image_ repository on github |emdash| :ref:`forking`.
|
||||
Fork the `scikit-image`_ repository on github |emdash| :ref:`forking`.
|
||||
Then::
|
||||
|
||||
# checkout and refresh master branch from main repo
|
||||
|
||||
@@ -49,7 +49,7 @@ Linking your repository to the upstream repo
|
||||
git remote add upstream git://github.com/scikit-image/scikit-image.git
|
||||
|
||||
``upstream`` here is just the arbitrary name we're using to refer to the
|
||||
main scikit-image_ repository at `scikit-image github`_.
|
||||
main `scikit-image`_ repository at `scikit-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
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
.. scikit-image
|
||||
.. _scikit-image: http://scikit-image.org
|
||||
.. _`scikit-image`: http://scikit-image.org
|
||||
.. _`scikit-image github`: http://github.com/scikit-image/scikit-image
|
||||
|
||||
.. _`scikit-image mailing list`: http://groups.google.com/group/scikit-image
|
||||
|
||||
Reference in New Issue
Block a user