Call out destructive command in README #4880
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
While it is the user's responsiblity to read the documentation and know what impact a command will have that they choose to run on their machine, I believe it would be helpful to draw more attention to the destructive commands that are featured in the README that cause Git to rewrite its commit objects. Many users will only skim the README, and the migration command that addresses a common use case should be called out more than it is for its side effects, in my opinion.
|
Hey, thanks for the patch and welcome to the Git LFS project! This looks good to me, so I'm going to merge it in. Thanks again! |
chrisd8088
approved these changes
Feb 16, 2022
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.
While it is the user's responsiblity to read the documentation and know
what impact a command will have that they choose to run on their
machine, I believe it would be helpful to draw more attention to the
destructive commands that are featured in the README that cause Git to
rewrite its commit objects.
Many users will only skim the README, and the migration command that
addresses a common use case should be called out more than it is for its
side effects, in my opinion.