Skip to content

Commit

Permalink
minor fix in notes, fill in badges
Browse files Browse the repository at this point in the history
  • Loading branch information
brownsarahm committed Feb 9, 2024
1 parent 1ad6cd4 commit 9136322
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
4 changes: 2 additions & 2 deletions _practice/2024-02-08.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
```{index}
```
1. Explore the [tools for conventional commits](https://www.conventionalcommits.org/en/about/#tooling-for-conventional-commits) and then pick one to try out. Use one of the tools that helps making conventional commits (eg in VSCode or a CLI for it)for a series of commits adding "features" and "bug fixes" telling the story of a code project in a file called {index}`commit-story.md`. For each edit, add short phrases like 'new feature 1', or 'next bug fix' to the single file each time, but use conventional commits for each commit. In total make at least 5 different types of changes (types per conventional commits standard) including 2 breaking changes and at least 10 total commits to the file.
2. [learn about options for how git can display commit history](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History). Try out a few different options. Choose two, write them both to a file, {index}`gitlog-compare.md`. Using a text editor, wrap each log with three backticks to make them "code blocks" and then add text to the file describing a use case where that format in particular would be helpful. **do this after the above so that your git log examples include your conventional commits**
4 changes: 2 additions & 2 deletions _review/2024-02-08.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
```{index}
```
1. Export your git log for your KWL main branch to a file called {index}`gitlog.txt` and commit that as exported to the branch for this issue. **note that you will need to work between two branchse to make this happen**. Append a blank line, `## Commands`, and another blank line to the file, then the command history used for this exercise to the end of the file.
2. In {index}`commit-def.md` compare two of the four ways we described a commit today in class. How do the two descriptions differ? How does defining it in different ways help add up to improve your understanding?
5 changes: 2 additions & 3 deletions notes/2024-02-08.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ classDiagram
object <|-- tree
object <|-- commit
```
+++




Expand Down Expand Up @@ -408,8 +408,6 @@ commit
## Commit messages are essential


+++


A git commit message must exist and is *always* for people, but can also be for machines.

Expand All @@ -422,6 +420,7 @@ the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.
if you use this, then you can use automated tools to generate a full change log when you release code


[Tooling and examples of conventional commits](https://www.conventionalcommits.org/en/about/)


+++
Expand Down

0 comments on commit 9136322

Please sign in to comment.