Skip to content
This repository has been archived by the owner on Apr 21, 2021. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
carlogilmar committed Sep 22, 2019
1 parent 18b7958 commit d0988ce
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,14 @@
* Install Node.js dependencies with `cd assets && npm install`
* Start Phoenix endpoint with `mix phx.server`

## Development

I implemented a git hook for add some valuable tools, so please for development then to clone this repo, run the *install_credo_hooks.sh* script. This script will install a *pre-push* git hook in this repo.

#### How it works?
The main goal for this hook is run credo before to make a push to the remote repository, if there are some credo suggestions, the push will be stopped, if you don't have suggestions the push will be uploaded.

Example
![](https://p10.f2.n0.cdn.getcloudapp.com/items/E0ulxmr7/Screen+Recording+2019-09-22+at+10.45+AM.gif?v=ce3356bd814b7d32783fd66a6e18168c)

I made this for ensure quality in the code analysis made by *Credo*

0 comments on commit d0988ce

Please sign in to comment.