Skip to content

docs: update README.md with end of line notice #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Geenag merged 2 commits into from
Oct 7, 2025
Merged

docs: update README.md with end of line notice #245

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c835f35
docs: update CONTRIBUTING.md with end of line notice
Geenag Sep 29, 2025
1854865
docs: feedbacks PR
Geenag Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions contribute/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down