Question about Commit Guidelines

[PedanticDan]

I'm was rereading the Commit Guidelines looking for guidance for commits that touch multiple components.
Specifically, I'm making a code change that affects UI, libobs/util, and win-dshow. I have not found an example of a commit message that references multiple components.

How should I handle this situation? Should I do three commits?

 

[Lain]

Here are the options, in order of most preferred:

1. If you can split it into multiple working and compilable commits, then that's usually the best option. Always try to separate code that isn't necessarily directly related.
2. Prefix with the most important/prominent module, then on the third line just make a note, see ebbe8d1 for an example
3. You can also do something like: libobs, UI: Modify bla bla bla -- just don't let it get too squishy. If it gets too squishy just do #2 instead.

 

[PedanticDan]

Thanks.

Though the changes are directly related in purpose, the change to win-dshow does not depend on the changes to libobs/uti or UI ... and the change to libobs/util does not depend on the changes to win-dshow or UI.

In this case, I think #2 seems best.