Skip to content

Use a separate commit for formatting changes

Enrique Alcántara requested to merge 277083-save-formatting-changes-in-separate-commit into master

What does this MR do?

Problem

One of the most frequent points of feedback from our roll-out of the Static Site Editor in the GitLab Handbook has been the volume of changes made to the source file simply as a result of opening the page in the WYSIWYG editor. We have tried to limit this by matching the expected Markdown formatting to the documented GitLab Markdown style guide. However, the reality is that many of the pages on the GitLab handbook to not adhere strictly to this style guide.

Proposal

To avoid cluttering the changes made by the user in the Static Site Editor with the auto-formatting changes, let’s separate both changesets in different commits. This will allow users to isolate and share the specific commit containing only their changes

Screenshots (strongly suggested)

After saving changes with the Static Site Editor, if the user opens the Merge Request created by the editor, they should see two commits. One of them contain the formatting changes introduced by the editor. The other one contains the changes introduced by the user

image

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team

Related to #277083 (closed)

Edited by Enrique Alcántara

Merge request reports