Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: minor tweaks to manual backport instructions #11186

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.

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 1 commit into from
May 8, 2018

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented May 7, 2018

PR Summary

A couple of minor tweaks to the backport instructions.

  • Changed the upstream remote name to upstream from matplotlib since I think thats what we tell people to use in the rest of the docs.
  • outlined the conflict process a bit more.
  • made it clear what branch should be PR'd against.

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@jklymak jklymak added this to the v2.2-doc milestone May 7, 2018
@jklymak jklymak force-pushed the doc-manual-backport-tweaks branch from f051132 to e2ea782 Compare May 7, 2018 18:15

git add lib/matplotlib/conflicted_file.py
git add lib/matplotlib/conflicted_file2.py
git commit -a -m "MRG: backport of SHA"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think you should add -a. You've already added the files manually.

Copy link
Member

@timhoffm timhoffm May 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. The message is in conflict with the text above: : "When doing backports please copy the form used by meeseekdev, Backport PR #XXXX: TITLE OF PR".
  2. Do we use prefixes like MRG for commit messages? If so, where's that documented?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Both comments fixed....

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... good thing I self merged my mis-titled backport PR 😉

@jklymak jklymak closed this May 7, 2018
@jklymak jklymak force-pushed the doc-manual-backport-tweaks branch from e2ea782 to 922c950 Compare May 7, 2018 20:05
@jklymak jklymak reopened this May 7, 2018
git cherry-pick -m 1 TARGET_SHA
# resolve conflicts and commit if required

Use your discretion to push directly to upstream or to open a PR.
The conflicts will have to be searched for by hand, (search on ``>>>>>``)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Conflicting files are shown in git status, so conflicts only need to be searched in those file, not all of them.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, OK, didn't know that. I'll change to suggesting that.

@jklymak jklymak force-pushed the doc-manual-backport-tweaks branch from a46d183 to 6ea6958 Compare May 7, 2018 21:18
@jklymak
Copy link
Member Author

jklymak commented May 7, 2018

@timhoffm
Copy link
Member

timhoffm commented May 7, 2018

I tried the tutorial on #11188.

After fixing the changes, I had to git cherry-pick continue, which opens an editor for the merge message.

@jklymak
Copy link
Member Author

jklymak commented May 7, 2018

Oh, didn’t know about that either. So did you have to commit as well? I.e. add, commit, continue, or just add and continue?

@timhoffm
Copy link
Member

timhoffm commented May 7, 2018

I just did add, continue, push.

@jklymak jklymak force-pushed the doc-manual-backport-tweaks branch from 6ea6958 to b3d5b40 Compare May 7, 2018 23:37
@jklymak
Copy link
Member Author

jklymak commented May 7, 2018

duly fixed...

@tacaswell tacaswell merged commit b38c382 into matplotlib:master May 8, 2018
jklymak added a commit that referenced this pull request May 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants