hexolan/stocklet
1
0
Fork 0
mirror of https://github.com/hexolan/stocklet.git synced 2026-03-26 11:41:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: misspell

Browse Source 
docs: add reference to conventional commit messages

corrections:
* `AVALIABLE` -> `AVAILABLE`
* `UNAVALIABLE` -> `UNAVAILABLE`
* `succesful` -> `successful`
This commit is contained in:
Declan Teevan
2025-03-14 10:50:06 +00:00
parent 0c9c64b377
commit fe910a160f
8 changed files with 28 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/README.md
View File

@@ -13,6 +13,8 @@ The code has been formatted using [`gofmt`](https://pkg.go.dev/cmd/gofmt).
The protobuf schema files have been formatted using [`buf format`](https://buf.build/docs/reference/cli/buf/format).
The markdown files have been linted and formatted using [markdownlint](https://github.com/DavidAnson/markdownlint).
The markdown files have been linted and formatted using [markdownlint](https://github.com/DavidAnson/markdownlint) (with the exception of MD013).
I used [PlantUML](https://plantuml.com/) as the tool to help make the diagrams. The PlantUML files are avaliable alongside the resulting images: [`/docs/imgs/overview.plantuml`](/docs/imgs/overview.plantuml) and [`/docs/imgs/placeordersaga.plantuml`](/docs/imgs/placeordersaga.plantuml)
Commit messages should adhere to the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) specification.
I used [PlantUML](https://plantuml.com/) as the tool to help make the diagrams. The PlantUML files are available alongside the resulting images: [`/docs/imgs/overview.plantuml`](/docs/imgs/overview.plantuml) and [`/docs/imgs/placeordersaga.plantuml`](/docs/imgs/placeordersaga.plantuml)

4
docs/imgs/placeordersaga.plantuml
View File

@@ -22,11 +22,11 @@ start
|Product|
:ProductPriceQuoteEvent;
if (type) is (<color:red>UNAVALIABLE) then
if (type) is (<color:red>UNAVAILABLE) then
|Order|
:<color:red>OrderRejectedEvent;
kill
else (<color:green>AVALIABLE)
else (<color:green>AVAILABLE)
endif
|Order|

4
docs/imgs/placeordersaga.svg
View File

@@ -23,9 +23,9 @@
<rect x="277" y="132.67" width="173" height="33.969" rx="3.5" ry="3.5" fill="#F1F1F1" stroke="#181818" stroke-width=".5"/>
<text x="287" y="153.8057" fill="#000000" font-family="sans-serif" font-size="12" textLength="153">ProductPriceQuoteEvent</text>
<polygon points="351.5 186.64 375.5 186.64 387.5 198.64 375.5 210.64 351.5 210.64 339.5 198.64" fill="#F1F1F1" stroke="#181818" stroke-width=".5"/>
<text x="367.5" y="220.8462" fill="#FF0000" font-family="sans-serif" font-size="11" textLength="74">UNAVALIABLE</text>
<text x="367.5" y="220.8462" fill="#FF0000" font-family="sans-serif" font-size="11" textLength="74">UNAVAILABLE</text>
<text x="351.5" y="202.4438" fill="#000000" font-family="sans-serif" font-size="11" textLength="24">type</text>
<text x="387.5" y="196.0415" fill="#008000" font-family="sans-serif" font-size="11" textLength="58">AVALIABLE</text>
<text x="387.5" y="196.0415" fill="#008000" font-family="sans-serif" font-size="11" textLength="58">AVAILABLE</text>
<line x1="271" x2="271" y1="12.745" y2="1264.8" stroke="#000" stroke-width="1.5"/>
<rect x="574.5" y="364.98" width="164" height="33.969" rx="3.5" ry="3.5" fill="#F1F1F1" stroke="#181818" stroke-width=".5"/>
<text x="584.5" y="386.1143" fill="#000000" font-family="sans-serif" font-size="12" textLength="144">StockReservationEvent</text>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB