Skip to content

Commit

Permalink
Fixing Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
whizzzkid committed Jul 7, 2022
1 parent 6c44c6a commit 3a74635
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,14 @@ git push --follow-tags

1. Gusto engineers may [go/deploy-committer-with-cpe-chef](https://go/deploy-committer-with-cpe-chef).

## Autofix
## Environment Specific Configuration

Committer can auto-fix everything by default. set `export COMMITTER_AUTO_FIX=true # or 1, T, t` in your
`~/.profile` or equivalent dotfile.

## Opting out of automatic staging

Committer will stage auto-corrected files by default. In order to always leave auto-corrected files unstaged for manual staging, set `export COMMITTER_SKIP_STAGE=1` in your `~/.bashrc` or equivalent.
Set these values in your `~/.profile` or equivalent env vars `export <flag>=<value>`

| Flag | Default | Expected | Description |
|---|---|---|---|
| COMMITTER_SKIP_STAGE | False | Truthy or Falsy | Committer will stage auto-corrected files by default. In order to always leave auto-corrected files unstaged for manual staging, set this value |
| COMMITTER_AUTO_FIX | False | Truthy or Falsy | Committer can auto-fix code formatting in staged files by default |

## Best-practices
### Purely Functional Pre-Commit Hooks
Expand Down

0 comments on commit 3a74635

Please sign in to comment.