Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement]: Add --no-commit Recommendation to Prevent Install Failures #2321

Open
sg-milad opened this issue Feb 6, 2025 · 0 comments
Open
Labels
enhancement Enhance existing content or processes triage

Comments

@sg-milad
Copy link

sg-milad commented Feb 6, 2025

What would you like us to improve?

When running forge install smartcontractkit/foundry-chainlink-toolkit, the installation fails if the Git working directory has untracked or modified files. The error message suggests either cleaning the Git state or using the --no-commit flag. However, the official documentation does not mention --no-commit, which can confuse new users.
** error message

Image

How important it is?

To improve the developer experience, the documentation should explicitly mention using the --no-commit flag when installing dependencies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhance existing content or processes triage
Projects
None yet
Development

No branches or pull requests

1 participant