docs: add pre-commit sample output

FullStackWithLawrence · Nov 19, 2023 · 4fc1a64 · 4fc1a64
1 parent 8420528
commit 4fc1a64
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/DEVELOPER_SETUP.md b/DEVELOPER_SETUP.md
@@ -23,6 +23,10 @@ pre-commit autoupdate
 pre-commit run --all-files
 ```
 
+Output should look similar to the following:
+
+![pre-commit output](./doc/pre-commit.png)
+
 ### Github Secrets
 
 The GitHub Actions automated processes depend on several credentials which are stored inside of Github Secrets. When creating pull requests, the GitHub Actions will use these secrets, [github.com/FullStackWithLawrence/aws-openai/settings/secrets/actions](https://github.com/FullStackWithLawrence/aws-openai/settings/secrets/actions), so there's nothing special for you to do.

diff --git a/doc/pre-commit.png b/doc/pre-commit.png
diff --git a/run_pylint.sh b/run_pylint.sh
@@ -1,2 +1,3 @@
 #!/bin/bash
+# Called from pre-commit. Run pylint on all python files in the current directory
 python -m pylint "$@"