Skip to content

Commit d236f84

Browse files
committed
docs(contributing): add entry to explain the usage of Git LFS
1 parent 1ccdc93 commit d236f84

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,13 @@ Besides publishing a new version to npm, semantic-release also creates a git tag
7979
on GitHub, generates changelogs from the commit messages and puts them into the release notes.
8080

8181
If the pull request looks good but does not follow the commit conventions, use the <kbd>Squash & merge</kbd> button.
82+
83+
## Troubleshooting
84+
85+
### When I clone the repository, files in `cached/` and `generated/` are empty
86+
87+
These folders are versioned using [Git Large File Storage](https://git-lfs.com/). Not having `git lfs` installed on your local machine could be the reason of this issue.
88+
You can download `Git LFS` and find the install steps here: [https://git-lfs.com/](https://git-lfs.com/)
89+
90+
If you would like to configure your local machine to show diffs for the files under LFS there's [this hack](https://github.com/git-lfs/git-lfs/issues/440#issuecomment-500871343):
91+
`git config diff.lfs.textconv cat`

0 commit comments

Comments
 (0)