search

OPM / opm-reference-manual

Other
1 stars 5 forks source link

Script to split git commit into two parts to make review of PRs easier #160

Closed hakonhagland closed 6 months ago

hakonhagland commented 6 months ago

Builds on #159 which should be merged first.

Added a script fodt-split-commit that can be used to split a commit for a single .fodt file into two commits. The purpose is to make the review of a PR easier by splitting (usually) irrelevant changes in the meta section into a separate commit. Then reviewer can focus on the changes in the body part of the document. The requirement for using the script is that the last commit contain changes to a single .fodt file. The commit is then replaced by two commits. The first one representing changes to the meta section of the .fodt file, and the second commit representing changes to the office:body section (the actual content of the file) of the .fodt file.

This script may not be extremely useful currently, as it cannot separate out style changes in the body part of the document yet. But it can work as a building block if we decide to make a more advanced script in the future.

Also added some test cases that can work as a starting point if we want to add more tests in the future.

hakonhagland commented 6 months ago

The place to document all fodt-* commands is the scripts/python/README.md file, right?

@lisajulia Yes correct.

If yes, can you add the new fodt-split-commit command there?

@lisajulia Yes good idea! See latest last commit..