Chore/#153875067 - Address direnv setup issue on MacOS in our setup guide (#107)

- other random formatting tweaks

Author: timdavish

Diff for: README.md

@@ -24,13 +24,13 @@
 Below is a cheatsheet for the scripts that can be found in `package.json`:
 
 ```bash
-$ yarn                            # install dependencies (npm install)
-$ yarn db                         # stop mongodb and seed db (npm run db)
-$ yarn start:dev                  # run in watch mode (npm run start:dev)
-$ yarn start                      # run the app through docker just like the test environment (npm start)
-$ yarn stop                       # stop and clean the app that was running through docker (npm stop)
-$ yarn test                       # run tests (npm test)
-$ yarn build                      # generate client distribution (npm run build)
+$ yarn                            # Install dependencies (npm install)
+$ yarn db                         # Restart a docker container with mongodb and add seed data (npm run db)
+$ yarn start:dev                  # Run the app locally in watch mode (npm run start:dev)
+$ yarn start                      # Run the app through docker just like the test environment (npm start)
+$ yarn stop                       # Stop and clean the app that was running through docker (npm stop)
+$ yarn test                       # Run tests (npm test)
+$ yarn build                      # Generate client distribution (npm run build)
 ```
 *Although yarn is recommended, you may also use npm natively. The corresponding npm commands are in parenthesis above.*
 

Diff for: docs/CONTRIBUTING.md

@@ -134,8 +134,11 @@ $ git checkout -b <story type>/<story id>
 Always pair when you start a new branch:
 
 ```bash
-$ git solo <initials>                   # if you are working solo
-$ git duet <initials-1> <initials-2>    # if you are pairing with someone
+# If you are working solo
+$ git solo <initials>
+
+# If you are pairing with someone
+$ git duet <initials-1> <initials-2>
 ```
 
 *For more details, go to [developer environment setup](./DEVELOPER.md#rest).*
@@ -147,7 +150,7 @@ Reference the pivotal tracker **story id** for the story you are working on:
 ```bash
 $ git commit
 
-# below, the commit message is between the ---'s
+# Below, the commit message is between the ---'s
 ---
 chore: add something
 

Diff for: docs/DEVELOPER.md

@@ -16,6 +16,7 @@ See the [contribution guidelines](./CONTRIBUTING.md) to start contributing.
 ```bash
 $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 ```
+
 *For more details, go to [Homebrew](https://brew.sh/).*
 
 ### <a name="rest"></a> 2. Install [Git Duet](https://github.com/git-duet/git-duet/#installation)
@@ -37,6 +38,7 @@ $ brew install yarn --without-node
 $ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.4/install.sh | bash
 $ nvm install
 ```
+
 *If you are on a Mac and having trouble, make sure to run `touch ~/.bash_profile` before running the above command.*
 
 ### 5. Install [Direnv](https://github.com/direnv/direnv#install)
@@ -46,6 +48,29 @@ $ brew install direnv
 $ echo 'eval "$(direnv hook bash)"' >> ~/.bashrc
 ```
 
+Note: In order for the above to work on MacOS, your .bash_profile needs to be setup to read your .bashrc by containing the following:
+
+```bash
+# Either this
+[[ -r ~/.bashrc ]] && . ~/.bashrc
+
+# Or this
+if [ -f $HOME/.bashrc ]; then
+  source $HOME/.bashrc
+fi
+```
+
+You can check your .bash_profile with:
+
+```bash
+$ open ~/.bash_profile
+
+# If it doesn't contain either of the above
+$ echo '[[ -r ~/.bashrc ]] && . ~/.bashrc' >> ~/.bash_profile
+```
+
+*After doing this, anything in your .bash_profile other than the configuration above can now be moved to your .bashrc*
+
 ### 6. Restart the terminal and then run the following
 
 ```bash
@@ -89,6 +114,7 @@ $ test -d /home/linuxbrew/.linuxbrew && PATH="/home/linuxbrew/.linuxbrew/bin:$PA
 $ test -r ~/.bash_profile && echo 'export PATH="$(brew --prefix)/bin:$PATH"' >>~/.bash_profile
 $ echo 'export PATH="$(brew --prefix)/bin:$PATH"' >>~/.bash_profile
 ```
+
 *For more details, go to [Linuxbrew](http://linuxbrew.sh/).*
 
 ### 3. Follow Mac OS Setup starting from [section 2](#rest)
@@ -97,7 +123,7 @@ $ echo 'export PATH="$(brew --prefix)/bin:$PATH"' >>~/.bash_profile
 
 > It is recommended that you use a mac or linux, but if you only have a pc, follow these steps to setup ubuntu bash.
 
-### 1. Shell Setup
+### Shell Setup
 
 1. Update your Windows 10 to the latest build.
 2. Run powershell as administrator and execute the following.