Skip to content

Commit

Permalink
docs: note git-lfs prerequisite (aws#31700)
Browse files Browse the repository at this point in the history
### 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*
  • Loading branch information
jimkang authored Oct 9, 2024
1 parent 2d255ea commit d80e3cd
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,8 @@ The following tools need to be installed on your system prior to installing the
- [Python >= 3.8.0, < 4.0](https://www.python.org/downloads/release/python-380/)
- [Docker >= 19.03](https://docs.docker.com/get-docker/)
- the Docker daemon must also be running
- [git-lfs](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)
- Without this, you'll get the message that the clone succeeded but the checkout failed when you initially clone the repo.

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

Expand Down

0 comments on commit d80e3cd

Please sign in to comment.