Skip to content

update the instructions in the contributing guide #4355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 20, 2020
Merged

update the instructions in the contributing guide #4355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d98520
use merge instead of rebase
keewis Aug 19, 2020
ddec2e7
update the delete-after-merge branch
keewis Aug 19, 2020
e5c97b3
update whats-new.rst
keewis Aug 19, 2020
5246a79
Merge branch 'master' into update-merge-instructions
keewis Aug 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions doc/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,9 @@ and switch in between them using the ``git checkout`` command.
To update this branch, you need to retrieve the changes from the master branch::

git fetch upstream
git rebase upstream/master
git merge upstream/master

This will replay your commits on top of the latest *xarray* git master. If this
This will combine your commits with the latest *xarray* git master. If this
leads to merge conflicts, you must resolve these before submitting your pull
request. If you have uncommitted changes, you will need to ``git stash`` them
prior to updating. This will effectively store your changes and they can be
Expand Down Expand Up @@ -824,21 +824,22 @@ Delete your merged branch (optional)
------------------------------------

Once your feature branch is accepted into upstream, you'll probably want to get rid of
the branch. First, merge upstream master into your branch so git knows it is safe to
delete your branch::
the branch. First, update your ``master`` branch to check that the merge was successful::

git fetch upstream
git checkout master
git merge upstream/master

Then you can do::

git branch -d shiny-new-feature
git branch -D shiny-new-feature

Make sure you use a lower-case ``-d``, or else git won't warn you if your feature
branch has not actually been merged.
You need to use a upper-case ``-D`` because the branch was squashed into a
single commit before merging. Be careful with this because ``git`` won't warn
you if you accidentally delete a unmerged branch.

The branch will still exist on GitHub, so to delete it there do::
If you didn't delete it using GitHub's interface, the branch will still exist on
GitHub. To delete it there do::

git push origin --delete shiny-new-feature

Expand Down
2 changes: 2 additions & 0 deletions doc/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ Documentation
By `Sander van Rijn <https://github.com/sjvrijn>`_.
- removed skipna argument from :py:meth:`DataArray.count`, :py:meth:`DataArray.any`, :py:meth:`DataArray.all`. (:issue:`755`)
By `Sander van Rijn <https://github.com/sjvrijn>`_
- update the contributing guide to use merges instead of rebasing and state
that we squash-merge. (:pull:`4355`) By `Justus Magin <https://github.com/keewis>`_.

Internal Changes
~~~~~~~~~~~~~~~~
Expand Down