From c904681acd12458b43023cbbf249b1d5ca0cf2a2 Mon Sep 17 00:00:00 2001 From: Derrick Stolee Date: Mon, 19 Mar 2018 09:04:55 -0400 Subject: [PATCH] CONTRIBUTING.md: check for whitespace before submitting Whitespace errors are easy to create but hard to check manually. Add two git commands that detect these whitespace errors to the commit cleanup section of CONTRIBUTING.md. Signed-off-by: Derrick Stolee --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55175d788f..328a65f771 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -316,6 +316,7 @@ Here are some other tips that we use when cleaning up our commits: * Make sure the commits are signed off using `git commit (-s|--signoff)`. See [SubmittingPatches](https://github.com/git/git/blob/v2.8.1/Documentation/SubmittingPatches#L234-L286) for more details about what this sign-off means. +* Check for whitespace errors using `git diff --check [base]...HEAD` or `git log --check`. * Run `git rebase --whitespace=fix` to correct upstream issues with whitespace. * Become familiar with interactive rebase (`git rebase -i`) because you will be reordering, squashing, and editing commits as your patch or series of patches is reviewed.