mirror of
https://github.com/hexolan/stocklet.git
synced 2026-03-26 19:51:17 +00:00
Declan Teevan
fe910a160f
docs: add reference to conventional commit messages corrections: * `AVALIABLE` -> `AVAILABLE` * `UNAVALIABLE` -> `UNAVAILABLE` * `succesful` -> `successful`
Stocklet Docs
Table of Contents
Formatting, styling, etc
The code has been formatted using gofmt.
The protobuf schema files have been formatted using buf format.
The markdown files have been linted and formatted using markdownlint (with the exception of MD013).
Commit messages should adhere to the Conventional Commits 1.0.0 specification.
I used PlantUML as the tool to help make the diagrams. The PlantUML files are available alongside the resulting images: /docs/imgs/overview.plantuml and /docs/imgs/placeordersaga.plantuml