docs(readme): add note about fetch-depth #25
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updating README.md to explicitly mention that fetch-depth is a key argument to checkout repo, otherwise this action is almost unusable.
orhun
reviewed
Jun 19, 2024
README.md
Outdated
Comment on lines
22
to
23
| ### Important Notes | ||
| - It is important to checkout the repositories as: |
There was a problem hiding this comment.
Maybe we can use the GitHub admonition syntax here. ("warning" or "important')
There was a problem hiding this comment.
I've implemented the requested changes.
Usage of git admonition syntax and some edits on documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updating README.md to explicitly mention that fetch-depth is a key argument to checkout repo, otherwise this action is almost unusable.