Skip to content

Commit d80e3cd

Browse files
authored
docs: note git-lfs prerequisite (#31700)
### Reason for this change Put git-lfs in the prerequisites to avoid a git checkout error on initial clone. (And a failed checkout means `yarn install` will fail.) ### Description of changes Added a note about it in contributing.md. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 2d255ea commit d80e3cd

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,8 @@ The following tools need to be installed on your system prior to installing the
210210
- [Python >= 3.8.0, < 4.0](https://www.python.org/downloads/release/python-380/)
211211
- [Docker >= 19.03](https://docs.docker.com/get-docker/)
212212
- the Docker daemon must also be running
213+
- [git-lfs](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)
214+
- Without this, you'll get the message that the clone succeeded but the checkout failed when you initially clone the repo.
213215

214216
First fork the repository https://github.com/aws/aws-cdk/fork, and then run the following commands to clone the repository locally.
215217

0 commit comments

Comments
 (0)