Skip to content

Commit

Permalink
Merge pull request #282 from dbfit/contrib-docs-git-autocrlf-guidelines
Browse files Browse the repository at this point in the history
Add end of line style guidelines to contributing docs
  • Loading branch information
benilovj committed May 3, 2014
2 parents 6e13af1 + c635459 commit f4bdb75
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ Please raise pull requests against master; the `gh-pages` branch is used only fo

Pull requests are most welcome, but please try to test them with the existing tests first.

#### Conventions

##### 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 don't have good support for the Unix 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`.

If your tools have good support for Unix end-of-line format - it's perfectly OK to run with autocrlf unconfigured (or `autocrlf = false`).

#### Fast build

The quickest way to get feedback on your code changes is to run the fast build:
Expand Down

0 comments on commit f4bdb75

Please sign in to comment.