From da40b3be03aa81eceb4c4ca24907dcaa6302c567 Mon Sep 17 00:00:00 2001 From: Skyler Grey Date: Wed, 8 Oct 2025 18:49:29 +0000 Subject: [PATCH] docs(*): add more information about projects Change-Id: wvmsszkkuttkorrnnmppvmpwvlrywrxt 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! --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3b100f48..78c2013a 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,21 @@ SPDX-License-Identifier: MIT *Patisserie* is a [monorepo](https://en.wikipedia.org/wiki/Monorepo), which means there are multiple projects hosted here. Here's a list! -| Project | Description | -| ----------- | ------------------------------------------------------------------------------------------------- | -| *packetmix* | Our [*NixOS*](https://nixos.org) configurations ("All you need to bake a delicious system") | -| *sprinkles* | Our [*Niri*](https://github.com/YaLTeR/niri) widgets ("Add some decoration to your Niri desktop") | +| Project | Shortcode | Description | +| ----------------- | --------- | ------------------------------------------------------------------------------------------------- | +| [*packetmix*][pm] | pm | Our [*NixOS*](https://nixos.org) configurations ("All you need to bake a delicious system") | +| [*sprinkles*][s] | s | Our [*Niri*](https://github.com/YaLTeR/niri) widgets ("Add some decoration to your Niri desktop") | + +[pm]: https://tangled.org/@freshlybakedca.ke/patisserie/tree/main/packetmix +[s]: https://tangled.org/@freshlybakedca.ke/patisserie/tree/main/sprinkles + +Projects are developed in individual directories, and have a workspace file in +`projects/${name}` to help you clone them down with everything they need. + +Shortcodes are used in commit messages as the first component of the area name +in [Conventional Commit style](https://conventionalcommits.org). For example, +feature commits to PacketMix should start with something like `feat(pm/...):`. +For commits that affect all areas, the special shortcode `*` is used. ## Cloning a single project -- 2.43.0