Skip to content

Commit aa1e54c

Browse files
authored
Improve BUILDING documentation, and fix typo in setup script (DataDog#7618)
* Add and modify some of the BUILDING documentation, and fix typo in setup script * Remove 'Troubleshooting' section
1 parent 5645fbc commit aa1e54c

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

‎BUILDING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This documentation is dedicated to developers to setup their environment, and bu
1010

1111
## Development environment quick check
1212

13-
As a preliminary step, you can quickly check that your development environment is properly set up to build the project running `./setup.sh` from the project root:
13+
To check that your development environment is properly set up to build the project, you will eventually run `./setup.sh` from the project root and should have its output look something like this:
1414

1515
```bash
1616
$ ./setup.sh

‎setup.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ function look-for-hook() {
5959
elif [ -e "$HOOKS_PATH/$HOOK_NAME" ] && [ "$(get-file-hash $HOOKS_PATH/$HOOK_NAME)" == "$HOOK_CHECKSUM" ]; then
6060
echo "✅ $HOOK_NAME hook is installed in git hooks path."
6161
else
62-
echo "🟨 $HOOK_NAME hook was not found (optional but recommanded)."
62+
echo "🟨 $HOOK_NAME hook was not found (optional but recommended)."
6363
fi
6464
}
6565

0 commit comments

Comments
 (0)