Skip to content

Doc: clarify that matplotlib prefers squash merging foll pull requests#31297

Closed
monika-2906-git wants to merge 1 commit intomatplotlib:mainfrom
monika-2906-git:doc-fix
Closed

Doc: clarify that matplotlib prefers squash merging foll pull requests#31297
monika-2906-git wants to merge 1 commit intomatplotlib:mainfrom
monika-2906-git:doc-fix

Conversation

@monika-2906-git
Copy link

PR summary

This PR clarifies in the development workflow documentation that
Matplotlib generally prefers squash merging when integrating pull
requests. Adding this explanation helps contributors understand the
preferred merge strategy used in the project.

AI Disclosure

AI was used to help understand the documentation structure and draft
the wording for the clarification.

PR checklist

  • "closes #0000" is in the body of the PR description
  • [N/A] new and changed code is tested
  • [N/A] Plotting related features are demonstrated in an example
  • [N/A] New Features and API Changes are noted
  • Documentation complies with guidelines

@github-actions github-actions bot added the Documentation: devdocs files in doc/devel label Mar 13, 2026
@melissawm
Copy link
Member

The lint check is failing because your line is too long and there's a trailing whitespace - consider installing pre-commit so these checks are run automatically when you commit your changes. Cheers!

@scottshambaugh
Copy link
Contributor

scottshambaugh commented Mar 13, 2026

Do we prefer squash merging? I can't find a previous discussion on that - please link it if you found one.

This isn't really relevant for the contributors docs anyway, as maintainers are the only ones with merge permissions. In my experience we generally use discretion on whether to keep commits as-is or to squash.

@scottshambaugh
Copy link
Contributor

scottshambaugh commented Mar 13, 2026

@monika-2906-git as a new contributor I also ask that you please see your first PR to completion before opening more, you've received feedback from multiple reviewers on how to continue making progress: #31253

@timhoffm
Copy link
Member

I think this is not quite true. We prefer a relatively clean history with semantically meaningful commits, because commits like "Fixed linting" or "Added tests" make history more complicated to read and do not add value.

How that is best achieved is a long and inconclusive debate. See also #28821

@monika-2906-git thanks for the willingness to contribute, however any documentation on this needs prior agreement, and that should be in the discussion of #28821.

@timhoffm timhoffm closed this Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: devdocs files in doc/devel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants