diff --git a/contribute/CONTRIBUTING.md b/contribute/CONTRIBUTING.md index 0549d3d..1a1f99e 100644 --- a/contribute/CONTRIBUTING.md +++ b/contribute/CONTRIBUTING.md @@ -14,6 +14,16 @@ And that's pretty much it ! You are now ready to get started. ## 2. Getting Started +### Prerequisite : Git LF/CRLF configuration (for Windows users) + +By default, Git on Windows may convert line endings (LF → CRLF). The whole IroCO2 project was configured to work with LF end-of-line. To avoid unwanted conversions, run one of the following: + +```bash +git config --system core.autocrlf false # per-system +git config --global core.autocrlf false # per-user +git config --local core.autocrlf false # per-project +``` + ### 2.1. For external contributors We use the [Forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow), used in