Skip to content

Commit

Permalink
cheat sheet git instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ryansurf committed Jun 1, 2024
1 parent 0d949c1 commit 2f6361a
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/cheat_sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When developing, these commands may come in handy:
| `poetry shell` | Activate the virtual environment |
| `poetry add <package-name>` | Add a new dependency to Poetry |
| `poetry add --group dev <package-name>` | Add a new developer dependency to Poetry |
| `poetry show` | List all available packages with descriptions |
| `poetry show` | List all available dependencies with descriptions |

## [Mkdocs Commands](https://www.mkdocs.org/user-guide/)

Expand All @@ -34,4 +34,19 @@ When developing, these commands may come in handy:
| `make test` | Runs pytest |
| `make test_docker` | Runs pytest on Docker |
| `make output_coverage` | Outputs the coverage of the tests |
| `make send_email` | Runs `send_email.py` |
| `make send_email` | Runs `send_email.py` |


## [Git](https://education.github.com/git-cheat-sheet-education.pdf)

| Argument | Description|
| -------- | ------- |
| `git clone <repo URL>` | Clones git repository to your local machine|
| `git add <file>` | Adds file to your next commit |
| `git commit -m <message>` | Commit your staged content (from `git add <file>`) |
| `git push` | Pushes lcoal changes to remote repo branch |
| `git status` | Shows modified files |
| `git branch` | Shows the branches |
| `git checkout -b <branch>` | Creates a new branch, `branch`, and switches into it |
| `git branch -d <branch>` | Delete a local branch |
| `git push -u origin <branch-name>` | Pushes a local branch to the upstream remote repo |

1 comment on commit 2f6361a

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
src
   __init__.py00100% 
   api.py86693%30, 48, 70–71, 103–104
   art.py9367%24–25, 37
   cli.py23483%34, 50–51, 55
   gpt.py10640%16–21, 32–45
   helper.py1435264%50, 52, 54, 56, 58, 60, 62, 64, 66, 68, 70, 81, 92–96, 129–137, 149, 162–163, 181–183, 193, 195–196, 218–219, 256–266, 273–281
   send_email.py24240%5–48
   server.py41410%5–82
   settings.py220100% 
TOTAL35813662% 

Tests Skipped Failures Errors Time
9 0 💤 0 ❌ 0 🔥 12.491s ⏱️

Please sign in to comment.