freshlybakedca.ke
Your one-stop-cake-shop for everything Freshly Baked has to offer
docs(*): add more information about projects
Our projects section isn't up-to-date with how we handle conventional
commits with Josh, and nor did it have links to the projects themselves
(which are now useful thanks to our work on adding README files to
subdirectories in Tangled). Let's update these things!
a.starrysky.fyi
+15
-4
+15
-4
README.md
+15
-4
README.md
···
13
13
*Patisserie* is a [monorepo](https://en.wikipedia.org/wiki/Monorepo), which means
14
14
there are multiple projects hosted here. Here's a list!
15
15
16
-
| Project | Description |
17
-
| ----------- | ------------------------------------------------------------------------------------------------- |
18
-
| *packetmix* | Our [*NixOS*](https://nixos.org) configurations ("All you need to bake a delicious system") |
19
-
| *sprinkles* | Our [*Niri*](https://github.com/YaLTeR/niri) widgets ("Add some decoration to your Niri desktop") |
16
+
| Project | Shortcode | Description |
17
+
| ----------------- | --------- | ------------------------------------------------------------------------------------------------- |
18
+
| [*packetmix*][pm] | pm | Our [*NixOS*](https://nixos.org) configurations ("All you need to bake a delicious system") |
19
+
| [*sprinkles*][s] | s | Our [*Niri*](https://github.com/YaLTeR/niri) widgets ("Add some decoration to your Niri desktop") |
20
+
21
+
[pm]: https://tangled.org/@freshlybakedca.ke/patisserie/tree/main/packetmix
22
+
[s]: https://tangled.org/@freshlybakedca.ke/patisserie/tree/main/sprinkles
23
+
24
+
Projects are developed in individual directories, and have a workspace file in
25
+
`projects/${name}` to help you clone them down with everything they need.
26
+
27
+
Shortcodes are used in commit messages as the first component of the area name
28
+
in [Conventional Commit style](https://conventionalcommits.org). For example,
29
+
feature commits to PacketMix should start with something like `feat(pm/...):`.
30
+
For commits that affect all areas, the special shortcode `*` is used.
20
31
21
32
## Cloning a single project
22
33