Skip to content

Add end of line style guidelines to contributing docs#282

Merged
benilovj merged 2 commits intomasterfrom
contrib-docs-git-autocrlf-guidelines
May 3, 2014
Merged

Add end of line style guidelines to contributing docs#282
benilovj merged 2 commits intomasterfrom
contrib-docs-git-autocrlf-guidelines

Conversation

@javornikolov
Copy link
Copy Markdown
Contributor

No description provided.

CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

benilovj added a commit that referenced this pull request May 3, 2014
Add end of line style guidelines to contributing docs
@benilovj benilovj merged commit f4bdb75 into master May 3, 2014
@benilovj benilovj deleted the contrib-docs-git-autocrlf-guidelines branch May 3, 2014 21:27
@benilovj benilovj added the docs label May 4, 2014
@benilovj benilovj added this to the 3.0.0 milestone May 4, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants