Skip to content

Clarify squashing doc

Marcin Sedlak-Jakubowski requested to merge msj-merge-commit into master

What does this MR do?

Clarify an apparent logical conflict in Squash and merge, as pointed out by a user, where we say "many commits are squashed into one commit", and show that there are, in fact two, only at the end mentioning the merge commit.

It's worth addressing the reader's possible confusion earlier on.

I also trimmed one of the images to only show relevant commits.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcin Sedlak-Jakubowski

Merge request reports