Skip to content

Add helper note when cloning the project on windows to avoid auto cr/… - #70

Open
cobinrox wants to merge 1 commit into
laugiov:mainfrom
cobinrox:docs/add-windows-helper-note-when-cloning
Open

cobinrox wants to merge 1 commit into
laugiov:mainfrom
cobinrox:docs/add-windows-helper-note-when-cloning

Conversation

@cobinrox

Copy link
Copy Markdown

Add helper note when cloning the project on windows to avoid auto cr/lf clashes. Although a Windows user may already have their Git set up to NOT switch LF to CR/LF, this simple note may save some developers a few hours of debugging time.

Pipeline: chore
Spec:
Gates:
Deploy-impact: none -- just a handy note for anyone cloning on Windows was added

Summary

Adds a note for developers cloning to a Windows box. Although the developers may already have Git set up to NOT convert linefeeds to cr/linefeeds, there may be times when that is not the case. Adding just this simple extra note may save them several hours of debugging.

Closes #

Changes

  • docs/08_getting_started.md

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Refactoring (no functional change)
  • Documentation update
  • Infrastructure / CI change

Checklist

  • make test passes (unit + integration + functional — CI does not run functional) (NOTE: I CANNOT RUN THE MAKE COMMANDS YET DUE TO WINDOWS DOCKER ISSUES THAT I AM WORKING ON IN ANOTHER BRANCH. )
  • make stan passes (PHPStan level 8 over src)
  • make cs-fixer applied and left the worktree unchanged
  • New code has tests
  • Documentation updated if needed
  • No secrets or credentials in the code
  • Follows DDD architecture (controllers delegate to handlers)

Factory gates

  • Every commit and task cites a requirement id (feature pipeline)
  • Gate reports linked in the Gates: line above
  • Escalation triggers listed in the gate report, including the ones that did not fire
  • For a bug or security PR: the reproduction or exploit test is committed before the fix, and its failure output is in this description

Screenshots (if applicable)

image

@cobinrox

Copy link
Copy Markdown
Author

I wasn't able to run make test on Windows/Git Bash, because it failed at docker compose up (my Docker setup lacks the Compose v2 plugin). This PR only changes documentation, so it shouldn't affect the tests

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant