From 3a74635ae8313c82cbcf5e90fd9df24d1f47b141 Mon Sep 17 00:00:00 2001 From: Nishant Arora Date: Thu, 7 Jul 2022 17:54:08 -0600 Subject: [PATCH] Fixing Readme --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7ba80f5..31d79e6 100644 --- a/README.md +++ b/README.md @@ -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 | 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