From 0fb6b9c3b8278ea09d73af0bd9a27b50509e6d04 Mon Sep 17 00:00:00 2001
From: oliviasculley <olivia@sculley.dev>
Date: Thu, 5 Dec 2024 22:15:46 -0500
Subject: [PATCH] add handy commands to the readme

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 969c6af..a35f895 100644
--- a/README.md
+++ b/README.md
@@ -145,6 +145,15 @@ good idea!
   `pyproject.toml`. This is only necessary if you're adding or removing a new
   dependency to the project.
 
+## Handy commands
+
+- `pip install .[test]`: Install test dependencies
+- `python -m black src/`: Format source files
+- `python -m isort --check src/`: sort imports with isort
+- `python -m ssort --check src/`: sorts python code
+- `python -m pylint src/`: Runs linter, try to get a 10/10 score!
+- `python -m pytest tests/`: Runs tests
+
 ## License
 
 This bot is licensed under the MIT license.