Skip to content
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.

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

git lfs in README #115

Merged
merged 7 commits into from
Jan 24, 2022
Merged

git lfs in README #115

merged 7 commits into from
Jan 24, 2022

Conversation

ClFeSc
Copy link
Contributor

@ClFeSc ClFeSc commented Jan 24, 2022

Closes #40

@ClFeSc ClFeSc requested a review from Dassderdie January 24, 2022 08:07
@ClFeSc ClFeSc self-assigned this Jan 24, 2022
@ClFeSc ClFeSc changed the base branch from main to dev January 24, 2022 08:07
Copy link
Collaborator

@Dassderdie Dassderdie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I abused this branch for a bit more documentation stuff - look at the last two commits.

README.md Outdated Show resolved Hide resolved
@Dassderdie
Copy link
Collaborator

Dassderdie commented Jan 24, 2022

Also: should we maybe change all the npm i into npm ci? This would make sure that all changes in the dependencies are happening deliberately. You should then only run npm i if you know what you're doing. - nevermind - it seems like npm i shouldn't change the package-lock.json (anymore): npm/cli#564 (comment)

@Dassderdie
Copy link
Collaborator

@ClFeSc By default the images tracked by git lfs wouldn't render in vscode changes view.
I found git-lfs/git-lfs#440 (comment) . With the command git config diff.lfs.textconv cat it works. Do we want to persist that in the readme too?

I'm not quite sure about the consequences... here (third last point) is the official documentation from git lfs.

@ClFeSc
Copy link
Contributor Author

ClFeSc commented Jan 24, 2022

@ClFeSc By default the images tracked by git lfs wouldn't render in vscode changes view. I found git-lfs/git-lfs#440 (comment) . With the command git config diff.lfs.textconv cat it works. Do we want to persist that in the readme too?

I'm not quite sure about the consequences... here (third last point) is the official documentation from git lfs.

It worked for me. I don't think there should be a major drawback to using/recommending it.

Copy link
Contributor Author

@ClFeSc ClFeSc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're additions look good.

@Dassderdie
Copy link
Collaborator

I added it in the last commit.

Copy link
Collaborator

@Dassderdie Dassderdie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ClFeSc ClFeSc merged commit a1a8c71 into dev Jan 24, 2022
@ClFeSc ClFeSc deleted the docs/40-git-lfs-readme branch January 24, 2022 16:24
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.

Mention git lfs in the readme
2 participants