docs: remove deprecated --no-commit flag from installation instructions#55
Open
AryanPandeyDev wants to merge 1 commit intosmartcontractkit:mainfrom
Open
docs: remove deprecated --no-commit flag from installation instructions#55AryanPandeyDev wants to merge 1 commit intosmartcontractkit:mainfrom
AryanPandeyDev wants to merge 1 commit intosmartcontractkit:mainfrom
Conversation
Updated the README.md to reflect changes in recent Foundry versions where the --no-commit flag has been removed. The flag is no longer needed as Foundry does not automatically commit installations anymore. Changes: - Removed --no-commit flag from forge install command - Added note explaining the flag removal and behavior change - Simplified installation instructions for better clarity - Maintained all other documentation sections unchanged This update ensures users don't encounter the "unexpected argument" error when following the installation guide with current Foundry versions.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR fixes the installation instructions in the README by removing the deprecated
--no-commitflag that causes errors in current Foundry versions.What's the issue?
The current documentation instructs users to run:
This results in an error:
What changed?
--no-commitflag from the installation commandWhy?
Recent Foundry versions removed the
--no-commitflag because the tool no longer automatically commits installations. The flag is now obsolete and causes the installation to fail.Impact:
Users can now successfully install the package by following the updated documentation without encountering errors.