"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/source/gitwash/patching.rst" between
scikit-image-0.18.1.tar.gz and scikit-image-0.18.3.tar.gz

About: scikit-image is a collection of algorithms for image processing in Python.

patching.rst  (scikit-image-0.18.1):patching.rst  (scikit-image-0.18.3)
skipping to change at line 45 skipping to change at line 45
git branch the-fix-im-thinking-of git branch the-fix-im-thinking-of
git checkout the-fix-im-thinking-of git checkout the-fix-im-thinking-of
# hack, hack, hack # hack, hack, hack
# Tell git about any new files you've made # Tell git about any new files you've made
git add somewhere/tests/test_my_bug.py git add somewhere/tests/test_my_bug.py
# commit work in progress as you go # commit work in progress as you go
git commit -am 'BF - added tests for Funny bug' git commit -am 'BF - added tests for Funny bug'
# hack hack, hack # hack hack, hack
git commit -am 'BF - added fix for Funny bug' git commit -am 'BF - added fix for Funny bug'
# make the patch files # make the patch files
git format-patch -M -C master git format-patch -M -C main
Then, send the generated patch files to the `scikit-image Then, send the generated patch files to the `scikit-image
mailing list`_ |emdash| where we will thank you warmly. mailing list`_ |emdash| where we will thank you warmly.
In detail In detail
--------- ---------
#. Tell git who you are so it can label the commits you've #. Tell git who you are so it can label the commits you've
made:: made::
skipping to change at line 94 skipping to change at line 94
signals that you're going to type a message on the command signals that you're going to type a message on the command
line. The ``a`` flag |emdash| you can just take on faith |emdash| line. The ``a`` flag |emdash| you can just take on faith |emdash|
or see `why the -a flag?`_. or see `why the -a flag?`_.
#. When you have finished, check you have committed all your #. When you have finished, check you have committed all your
changes:: changes::
git status git status
#. Finally, make your commits into patches. You want all the #. Finally, make your commits into patches. You want all the
commits since you branched from the ``master`` branch:: commits since you branched from the ``main`` branch::
git format-patch -M -C master git format-patch -M -C main
You will now have several files named for the commits:: You will now have several files named for the commits::
0001-BF-added-tests-for-Funny-bug.patch 0001-BF-added-tests-for-Funny-bug.patch
0002-BF-added-fix-for-Funny-bug.patch 0002-BF-added-fix-for-Funny-bug.patch
Send these files to the `scikit-image mailing list`_. Send these files to the `scikit-image mailing list`_.
When you are done, to switch back to the main copy of the When you are done, to switch back to the main copy of the
code, just return to the ``master`` branch:: code, just return to the ``main`` branch::
git checkout master git checkout main
Moving from patching to development Moving from patching to development
=================================== ===================================
If you find you have done some patches, and you have one or If you find you have done some patches, and you have one or
more feature branches, you will probably want to switch to more feature branches, you will probably want to switch to
development mode. You can do this with the repository you development mode. You can do this with the repository you
have. have.
Fork the `scikit-image`_ repository on github |emdash| :ref:`forking`. Fork the `scikit-image`_ repository on github |emdash| :ref:`forking`.
Then:: Then::
# checkout and refresh master branch from main repo # checkout and refresh main branch from main repo
git checkout master git checkout main
git pull origin master git pull origin main
# rename pointer to main repository to 'upstream' # rename pointer to main repository to 'upstream'
git remote rename origin upstream git remote rename origin upstream
# point your repo to default read / write to your fork on github # point your repo to default read / write to your fork on github
git remote add origin git@github.com:your-user-name/scikit-image.git git remote add origin git@github.com:your-user-name/scikit-image.git
# push up any branches you've made and want to keep # push up any branches you've made and want to keep
git push origin the-fix-im-thinking-of git push origin the-fix-im-thinking-of
Then you can, if you want, follow the Then you can, if you want, follow the
:ref:`development-workflow`. :ref:`development-workflow`.
 End of changes. 6 change blocks. 
8 lines changed or deleted 8 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)