Add instructions to rebase and push branch before merging

[yalsayyad]

No description provided.

[jonathansick]

Here are some suggestions on how to reorganize the content for flow.

[jonathansick]

Delete this comment. Instead, before the code block, write:

First, prepare the merge by making sure the branch is up-to-date:

[jonathansick]

Delete this comment.

Now add the paragraph + list starting with "We force push..." here.

Then introduce a new code block:

Next, merge to ``master`` and push.
We **always use non-fast forward merges** so that the merge point is marked in Git history, with the merge commit containing the ticket number:

.. code-block:: bash

   git checkout master
   git merge --no-ff tickets/DM-NNNN
   git push

[jonathansick]

This means you can delete the identical paragraph, We **always use ... from before the two code blocks.

[timj]

@yalsayyad I've rebased and dealt with the second half of @jonathansick 's comments.

[jonathansick]

Please address this syntax error, rebase, then re-push.

https://travis-ci.com/lsst-dm/dm_dev_guide/builds/129509687#L653-L654

I'm guessing there are single backticks around master; they need to be double backticks to treat that word as a code literal instead of an API link.

[jonathansick]

Looks good.

[yalsayyad]

Recent events inspired me to revisit this, and now I remember why I stopped. I'm torn with indecision on @jonathansick's suggestion. It flows a lot better and makes more sense. But I only read code blocks, and I worry that separating the git merge --no-ff tickets/DM-XXXXX from the git checkout master/git pull will just make people even MORE likely to skip the necessary steps before merging to master. Help.

[jdswinbank]

I think revisiting this is a great idea. On balance, I'd probably go with Jonathan's wording, but I'd love to see this merged in either form.

[jdswinbank]

Hey folks, can we just merge this? The issue is coming up again today, and I'd love to be able to point people to docs. Either wording is okay, and we should definitely avoid the whole perfect-and-the-good thing.

[jonathansick]

Sorry, is anything waiting on me?

[jonathansick]

To expand; I did approve this ages ago, so I'm also wondering why this isn't merged. Shall I just do the rebase and merge now?

[jdswinbank]

I think @yalsayyad is conflicted by your suggestion and doesn't know which way to jump. 😀

Let's give her a few hours to call it, otherwise it's probably fine to just jump in and merge.

[parejkoj]

It'll take a potentially exciting rebase now, but I do think we should still merge this.