Skip to content

Conversation

@Neelterminusdb
Copy link
Contributor

@Neelterminusdb Neelterminusdb commented Mar 26, 2022

closes #145

Signed-off-by: NeelParihar neel@terminusdb.com

Signed-off-by: NeelParihar <neel@terminusdb.com>
@spl
Copy link
Contributor

spl commented Mar 28, 2022

Can you update the README.md with instructions on how to use it?

@Neelterminusdb
Copy link
Contributor Author

It says that it automatically sets up husky when someone clones the repo and installs packages(Which i tested now and is working correct) so i don't think there is any other extra step which needs to be done by user

@Neelterminusdb
Copy link
Contributor Author

And for someone who has already cloned the repo before husky implementation just need to run npm run prepare command to set it up

@spl
Copy link
Contributor

spl commented Mar 28, 2022

You're right in that the user doesn't need to take active steps to use it. But I've encountered this before and was surprised and confused by it. It's not the normal procedure for everybody who might be working on this repo.

I don't want other people to have the same reaction that I did, so I think it would be good if the README.md gave a brief description of what happens when they do npm install and that git commit will do something before it's usual operation. It should link to Husky as well.

Neelterminusdb and others added 2 commits March 28, 2022 20:42
Signed-off-by: NeelParihar <neel@terminusdb.com>
@Neelterminusdb Neelterminusdb merged commit 652c805 into main Apr 4, 2022
@Neelterminusdb Neelterminusdb deleted the AddHusky branch April 4, 2022 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add husky for running scripts before committing

3 participants