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

Expand setup documentation to cover both usage modes #48

Open
calebcartwright opened this issue Jun 5, 2019 · 0 comments
Open

Expand setup documentation to cover both usage modes #48

calebcartwright opened this issue Jun 5, 2019 · 0 comments
Assignees
Labels
documentation Related to documentation
Milestone

Comments

@calebcartwright
Copy link
Member

This isn't obvious from the current docs, but users of rusty-hook have two ways of leveraging it in their projects.

  1. more automatic/forced way - add it as a dev dependency, and then any dev/contributor on your repo will get the hooks set up automagically
  2. more optional/opt-in way - instead of adding it as a dev dep, users could suggest/encourage devs/contributors to manually install (cargo install rusty-hook) and then run the rusty-hook init command if the dev/contributor wanted to set up local git hooks in his or her environment.

We certainly prefer to use option 1 in our personal repos, but given that rusty-hook gives flexibility/choice to the consumers, it's important for the docs to clearly convey those options so folks can choose the option that works best for them and their projects

@calebcartwright calebcartwright added the documentation Related to documentation label Jun 5, 2019
@calebcartwright calebcartwright self-assigned this Jun 5, 2019
@calebcartwright calebcartwright added this to the 1.x Release milestone Jun 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation
Projects
None yet
Development

No branches or pull requests

1 participant