Merge pull request #6083 from Helios747/clang

Update Contributing.md to warn Windows users about line endings
This commit is contained in:
Leo Lam 2017-09-21 17:27:41 +02:00 committed by GitHub
commit 106539f346
1 changed files with 2 additions and 0 deletions

View File

@ -28,6 +28,8 @@ This project uses clang-format (stable branch) to check for common style issues.
## <a name="intro-formatting-issues"></a>Checking and fixing formatting issues ## <a name="intro-formatting-issues"></a>Checking and fixing formatting issues
Windows users need to be careful about line endings. Windows users should configure git to checkout UNIX-style line endings to keep clang-format simple.
In most cases, clang-format can and **should** be used to automatically reformat code and solve most formatting issues. In most cases, clang-format can and **should** be used to automatically reformat code and solve most formatting issues.
- To run clang-format on all staged files: - To run clang-format on all staged files: