Organizing your changes for pull requests

Some ideas about how to structure your PRs to make everyone's lives easier.

When we discover a bug, we use git bisect to find the commit responsible for the bug.

In order to make this process quicker and less painful, it's good to keep multiple small commits. Give them meaningful commit messages, include bug number, etc.

Please don't mix large code reformats with logical changes. Try to keep these in separate commits.

Indentation changes are fine: because git and github can ignore whitespace changes. Renaming files should be fine too most of the time.

But moving large blocks of code is bad. Makes it impossible to see what's really changed.

It's not recommended to squash refactoring commits with code change commits.

Try reading your own diff, and see if you could understand what has changed, and whether it can be done better. Thanks for consideration.