mirror of
https://github.com/wassname/scikit-image.git
synced 2026-08-20 12:50:52 +08:00
Rename scikits-image to scikit-image
This commit is contained in:
@@ -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 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.
|
||||
|
||||
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 scikit-image ``master`` branch, as
|
||||
"trunk".
|
||||
|
||||
* Don't use your ``master`` branch for anything. Consider deleting it.
|
||||
@@ -22,9 +22,9 @@ In what follows we'll refer to the upstream scikits-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 `scikits-image mailing list`_ if you get stuck.
|
||||
* Ask on the `scikit-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 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::
|
||||
@@ -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/scikit-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 scikit-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/scikit-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/scikit-image.git
|
||||
|
||||
Remember that links starting with ``git@`` use the ssh protocol and are
|
||||
read-write; links starting with ``git://`` are read-only.
|
||||
|
||||
Reference in New Issue
Block a user