wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-09-11 12:43:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #593 from ahojnnes/rebase-workflow

Browse Source 
Rebase workflow
This commit is contained in:
Tony S Yu
2013-06-20 04:33:25 -07:00
parent 79a5ab0e12 d7843529b5
commit 28c8a9b93d
1 changed files with 95 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.txt
+95 -64
View File
@@ -5,37 +5,50 @@ Here's the long and short of it:
1. If you are a first-time contributor: 1. If you are a first-time contributor:
* Go to `https://github.com/scikit-image/scikit-image * Go to `https://github.com/scikit-image/scikit-image
<http://github.com/scikit-image/scikit-image>`_ and click the <http://github.com/scikit-image/scikit-image>`_ and click the
"fork" button to create your own copy of the project. "fork" button to create your own copy of the project.
* Clone the project to your local computer:
``git clone git@github.com:john_doe/scikit-image.git`` * Clone the project to your local computer::
* Add origin and user branches:
``git remote rm origin`` git clone git@github.com:your-username/scikit-image.git
``git remote add origin git@github.com:scikit-image/scikit-image.git``
``git remote add john_doe git@github.com:john_doe/scikit-image.git`` * Add upstream repository::
Now, ``origin`` refers to the ``scikit-image`` repository and
``john_doe`` (your username) to yours. git remote add upstream git@github.com:scikit-image/scikit-image.git
* Now, you have remote repositories named:
- ``upstream``, which refers to the ``scikit-image`` repository
- ``origin``, which refers to your personal fork
2. Develop your contribution: 2. Develop your contribution:
* Pull the latest changes from upstream * Pull the latest changes from upstream::
(``git checkout master ; git pull origin master``)
* Create a branch for the feature you want to work on. Since the git checkout master
branch name will appear in the merge message, use a sensible name git pull upstream master
such as 'transform-speedups':
``git checkout -b transform-speedups`` * Create a branch for the feature you want to work on. Since the
* Commit locally as you progress (``git add`` and ``git commit``) branch name will appear in the merge message, use a sensible name
such as 'transform-speedups'::
git checkout -b transform-speedups
* Commit locally as you progress (``git add`` and ``git commit``)
3. To submit your contribution: 3. To submit your contribution:
* Push your changes back to GitHub: * Push your changes back to your fork on GitHub::
``git push john_doe transform-speedups``.
* Go to GitHub. The new branch will show up with a Pull Request button--click git push origin transform-speedups
it.
* If you want, post on the `mailing list * Go to GitHub. The new branch will show up with a Pull Request button -
<http://groups.google.com/group/scikit-image>`_ to explain your changes or click it.
to ask for review.
* If you want, post on the `mailing list
<http://groups.google.com/group/scikit-image>`_ to explain your changes or
to ask for review.
For a more detailed discussion, read these :doc:`detailed documents For a more detailed discussion, read these :doc:`detailed documents
<gitwash/index>` on how to use Git with ``scikit-image`` <gitwash/index>` on how to use Git with ``scikit-image``
@@ -43,64 +56,82 @@ For a more detailed discussion, read these :doc:`detailed documents
.. note:: .. note::
Do *not* ever merge the main branch into yours. If GitHub indicates that To reviewers: add a short explanation of what a branch did to the merge
the Pull Request can no longer be merged automatically, rebase onto master:: message and, if closing a bug, also add "Closes gh-123" where 123 is the
bug number.
git fetch origin/master
git rebase origin/master
(If you are curious, here's a further discussion on Divergence between ``upstream master`` and your feature branch
the `dangers of rebasing <http://tinyurl.com/lll385>`__. Also ..............................................................
see this `LWN article <http://tinyurl.com/nqcbkj>`__.)
* To reviewers: add a short explanation of what a branch did to the merge Do *not* ever merge the main branch into yours. If GitHub indicates that the
message and, if closing a bug, also add "Closes gh-123" where 123 is the branch of your Pull Request can no longer be merged automatically, rebase
bug number. onto master::
git checkout master
git pull upstream master
git checkout transform-speedups
git rebase master
If any conflicts occur, fix the according files and continue::
git add conflict-file1 conflict-file2
git rebase --continue
However, you should only rebase your own branches and must generally not
rebase any branch which you collaborate on with someone else.
Finally, you must push your rebased branch::
git push --force origin transform-speedups
(If you are curious, here's a further discussion on the
`dangers of rebasing <http://tinyurl.com/lll385>`__.
Also see this `LWN article <http://tinyurl.com/nqcbkj>`__.)
Guidelines Guidelines
---------- ----------
* All code should have tests (see `test coverage`_ below for more details). * All code should have tests (see `test coverage`_ below for more details).
* All code should be documented, to the same * All code should be documented, to the same
`standard <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines>`_ `standard <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines>`_
as NumPy and SciPy. as NumPy and SciPy.
* For new functionality, always add an example to the * For new functionality, always add an example to the
gallery. gallery.
* No changes should be committed without review. Ask on the * No changes should be committed without review. Ask on the
`mailing list <http://groups.google.com/group/scikit-image>`_ if `mailing list <http://groups.google.com/group/scikit-image>`_ if
you get no response to your pull request. you get no response to your pull request.
**Never merge your own pull request.** **Never merge your own pull request.**
* Examples in the gallery should have a maximum figure width of 8 inches. * Examples in the gallery should have a maximum figure width of 8 inches.
Stylistic Guidelines Stylistic Guidelines
-------------------- --------------------
* Set up your editor to remove trailing whitespace. Follow `PEP08 * Set up your editor to remove trailing whitespace. Follow `PEP08
<www.python.org/dev/peps/pep-0008/>`__. Check code with pyflakes / flake8. <www.python.org/dev/peps/pep-0008/>`__. Check code with pyflakes / flake8.
* Use numpy data types instead of strings (``np.uint8`` instead of * Use numpy data types instead of strings (``np.uint8`` instead of
``"uint8"``). ``"uint8"``).
* Use the following import conventions:: * Use the following import conventions::
import numpy as np import numpy as np
import matplotlib.pyplot as plt import matplotlib.pyplot as plt
cimport numpy as cnp # in Cython code cimport numpy as cnp # in Cython code
* When documenting array parameters, use ``image : (M, N) ndarray``, * When documenting array parameters, use ``image : (M, N) ndarray``
``image : (M, N, 3) ndarray`` and then refer to ``M`` and ``N`` in the and then refer to ``M`` and ``N`` in the docstring, if necessary.
docstring.
* Functions should support all input image dtypes. Use utility functions such * Functions should support all input image dtypes. Use utility functions such
as ``img_as_float`` to help convert to an appropriate type. The output as ``img_as_float`` to help convert to an appropriate type. The output
format can be whatever is most efficient. This allows us to string together format can be whatever is most efficient. This allows us to string together
several functions into a pipeline, e.g.:: several functions into a pipeline, e.g.::
hough(canny(my_image)) hough(canny(my_image))
* Use `Py_ssize_t` as data type for all indexing, shape and size variables in * Use ``Py_ssize_t`` as data type for all indexing, shape and size variables
C/C++ and Cython code. in C/C++ and Cython code.
Test coverage Test coverage
------------- -------------