Add end of line style guidelines to contributing docs #282
Conversation
| ##### End of line style | ||
| DbFit is using Unix style end of line (`LF`) in source files. | ||
|
|
||
| Be careful with that on Windows where the default end of line style is `CR+LF`. If your editor or other tools are not supporting well the end of line conventions: you may consider using the help of Git's [autocrlf option](http://git-scm.com/book/en/Customizing-Git-Git-Configuration). If you do so, be aware that DbFit tests and VM setup scripts rely on having some files unchanged. So it's advised that you use `autocrlf = input` instead of `autocrlf = auto`. |
There was a problem hiding this comment.
If your editor or other tools are not supporting well the end of line conventions
I'd change that to If your editor or other tools don't have good support for the Unix end-of-line conventions
If you do so, be aware that DbFit tests and VM setup scripts rely on having some files unchanged
I'm not sure what you mean here... maybe you could expand on it?
There was a problem hiding this comment.
If you do so, be aware that DbFit tests and VM setup scripts rely on having some files unchanged
I'm not sure what you mean here... maybe you could expand on it?
I had in mind that in particular autocrlf=auto converts install_oracle.sh to CR+LF style which fails to execute inside the VM.
And for the tests - I meant some unit tests compares results with files under src/test/resources/dbfit/util/oracle and that will fail too if files are modified (even if it's just because of CR+LF vs LF difference). For these we have a hack in .gitattributes actually to prevent such accidents.
There was a problem hiding this comment.
I'm not completely sure actually what else may get broken if converted to CR+LF. If we're too specific - there is a risk to omit something while leaving the impression that this is an exhaustive list of all special cases.
Add end of line style guidelines to contributing docs
No description provided.