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

Documentation request - lefthook install #496

Closed
istrasci opened this issue May 30, 2023 · 4 comments · Fixed by #548
Closed

Documentation request - lefthook install #496

istrasci opened this issue May 30, 2023 · 4 comments · Fixed by #548
Labels
feature request A new lefthook feature description

Comments

@istrasci
Copy link

⚡ Summary

Add text/links to Install instructions concerning the lefthook install command for more visibility.

Value

I realize it is not technically part of installation, but I feel that the lefthook install command is the first logical step to perform after installation. However, this is not apparent (at least to me) from the current organization of the documentation, and can be particularly confusing for new users who do not know that this step is required.

Behavior and configuration changes

It would be nice to see some text in the Install section of the README indicating that running lefthook install after installation is a logical next step. And/or something similar in the Installation guide.

@istrasci istrasci added the feature request A new lefthook feature description label May 30, 2023
@sanmai-NL
Copy link
Contributor

Isn't the first step to define a lefthook.yml?

@istrasci
Copy link
Author

Isn't the first step to define a lefthook.yml?

Current docs say

Run lefthook install to initialize a lefthook.yml config and/or synchronize .git/hooks/ with your configuration.

So the file is not strictly needed before running lefthook install.

@mrexox
Copy link
Member

mrexox commented Sep 13, 2023

Hey! I've added a TL;DR instructions and also updated the Usage page. Does it feel good?

@istrasci
Copy link
Author

Yes, looks great! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request A new lefthook feature description
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants