Skip to content

restore rebase documenation #8398

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

Closed
tacaswell opened this issue Mar 29, 2017 · 10 comments
Closed

restore rebase documenation #8398

tacaswell opened this issue Mar 29, 2017 · 10 comments

Comments

@tacaswell
Copy link
Member

tacaswell commented Mar 29, 2017

This content is no longer on the master branch, not sure if it is also gone from 2.0.x

http://matplotlib.org/devel/gitwash/development_workflow.html?highlight=rebase#rebasing-a-pull-request-pr

This needs to be put back.

@tacaswell tacaswell added this to the 2.1 (next point release) milestone Mar 29, 2017
@tacaswell tacaswell added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Mar 29, 2017
@tacaswell
Copy link
Member Author

Never mind, I apparently can not read 🐑 http://matplotlib.org/devel/gitwash/development_workflow.html

Sorry for the noise.

@tacaswell tacaswell removed Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Mar 29, 2017
@tacaswell tacaswell modified the milestones: unassigned, 2.1 (next point release) Mar 29, 2017
@tacaswell tacaswell reopened this Jun 13, 2017
@tacaswell tacaswell modified the milestones: 2.1 (next point release), unassigned Jun 13, 2017
@tacaswell
Copy link
Member Author

#2742 <- most of this content is gone

@tacaswell
Copy link
Member Author

Looks like this is a result of #8137

@choldgraf
Copy link
Contributor

Just a quick thought on this text - it might be worth highlighting the interactive rebase earlier on. This is probably going to be more useful for committers who are asked to squash before merge.

Right now it's in a section after the first mention of rebase:

http://matplotlib.org/devel/gitwash/development_workflow.html?highlight=rebase#rewriting-commit-history

It isn't the easiest to discover. Maybe the rebase section just needs a "see for more ways to rebase", or maybe just adding in the words "squash before merge" etc so that people can ctrl+f it more easily. WDYT?

@tacaswell
Copy link
Member Author

@choldgraf
Copy link
Contributor

I'm just saying that if I were a new user opening a PR, looking for an explanation of how to squash a bunch of commits before merging, then this:

http://matplotlib.org/devel/gitwash/development_workflow.html?highlight=git%20rebase#rewriting-commit-history

is what I should use, but it'd be hard for me to find it. I think if the words "squash and merge" or something like this were in there, it'd be easier to find, ctrl+f for, etc. Also I think if there were something like

.. note::
   For interactive rebasing (used to squash multiple commits together),
   see :ref:`rewriting-commit-history`.

in this section:

http://matplotlib.org/devel/gitwash/development_workflow.html?highlight=git%20rebase#rebasing-on-trunk

it'd be easier to find

@tacaswell
Copy link
Member Author

matthew-brett/gitwash#13 ports the missing text to upstream gitwash.

@tacaswell tacaswell modified the milestones: 2.1 (next point release), 2.1.1 (next bug fix release) Sep 24, 2017
@tacaswell tacaswell modified the milestones: v2.1.1, v2.1.0-doc Oct 21, 2017
@QuLogic QuLogic modified the milestones: v2.1.0-doc, v2.1.1-doc Dec 10, 2017
@tacaswell tacaswell modified the milestones: v2.1.1-doc, v2.2-doc Feb 12, 2018
@oscargus oscargus removed this from the v2.2-doc milestone Sep 26, 2022
@story645
Copy link
Member

Is this closed since we have rebase documentation now? https://matplotlib.org/devdocs/devel/development_workflow.html#rebasing-on-upstream-main

Copy link

This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!

@github-actions github-actions bot added the status: inactive Marked by the “Stale” Github Action label Jun 26, 2024
@timhoffm
Copy link
Member

Done per #8398 (comment).

@timhoffm timhoffm removed the status: inactive Marked by the “Stale” Github Action label Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants