Skip to content

Commit d061861

Browse files
derrickstoleedscho
authored andcommitted
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 <[email protected]>
1 parent 5cbcf3b commit d061861

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,7 @@ Here are some other tips that we use when cleaning up our commits:
316316
* Make sure the commits are signed off using `git commit (-s|--signoff)`. See
317317
[SubmittingPatches](https://github.com/git/git/blob/v2.8.1/Documentation/SubmittingPatches#L234-L286)
318318
for more details about what this sign-off means.
319+
* Check for whitespace errors using `git diff --check [base]...HEAD` or `git log --check`.
319320
* Run `git rebase --whitespace=fix` to correct upstream issues with whitespace.
320321
* Become familiar with interactive rebase (`git rebase -i`) because you will be reordering,
321322
squashing, and editing commits as your patch or series of patches is reviewed.

0 commit comments

Comments
 (0)