zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-06-28 15:23:33 +02:00
Code Issues Projects Releases Packages Wiki Activity

Updated README.md to include a fix for line endings

Browse source 
Updated the readme to include a fix for windows machines...

On windows, you cannot run manage.py (or other related files) as they are using the wrong file endings. It basically doesn't know where to look.

The fix to this is to add .gitattribute locally and rebuild your project, so that it reverts to standard line-endings on your machine (but not elsewhere)
This commit is contained in:
zandercymatics 2023-08-02 13:04:37 -06:00
parent 7209e74f41
commit b7f10e2b92
No known key found for this signature in database
GPG key ID: FF4636ABEC9682B7
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/developer/README.md
View file

@ -18,6 +18,9 @@ If you're new to Django, see [Getting Started with Django](https://www.djangopro
Visit the running application at [http://localhost:8080](http://localhost:8080). Visit the running application at [http://localhost:8080](http://localhost:8080).
Note: If you are using Windows, you may need to change your [line endings](https://docs.github.com/en/get-started/getting-started-with-git/configuring-git-to-handle-line-endings).
If you'd rather not change this globally, add a .gitattributes file in the project root with `* text eol=lf` as the text content, and [refresh the repo](https://docs.github.com/en/get-started/getting-started-with-git/configuring-git-to-handle-line-endings#refreshing-a-repository-after-changing-line-endings)
## Branch Conventions ## Branch Conventions
We use the branch convention of `initials/branch-topic` (ex: `lmm/fix-footer`). This allows for automated deployment to a developer sandbox namespaced to the initials. We use the branch convention of `initials/branch-topic` (ex: `lmm/fix-footer`). This allows for automated deployment to a developer sandbox namespaced to the initials.