Doc: clarify that matplotlib prefers squash merging foll pull requests#31297
Doc: clarify that matplotlib prefers squash merging foll pull requests#31297monika-2906-git wants to merge 1 commit intomatplotlib:mainfrom
Conversation
|
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! |
|
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. |
|
@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 |
|
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. |
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