agendafs

A filesystem for your calendar.

commit 9b61bad03a4835170c70a1a7024dbf3231714654
parent 7899cfccf1b94ab8a9ea6ab6acf495b792b3d80c
Author: Marc Coquand <marc@coquand.email>
Date:   Fri,  1 Aug 2025 16:53:12 +0200

CONTRIBUTING

Diffstat:
M
CONTRIBUTING.md
 | 
16
+++++++++-------

1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,15 +2,17 @@
 
 ## Commit messages
 
-Documentation changes do not need any extensive git commit
-message beyond just "docs". Otherwise, try to describe in summary
-what was done and in the description why. [Reference tickets if
-needed](https://man.sr.ht/git.sr.ht/#referencing-tickets-in-git-commit-messages)
+Minor changes can be just a single word. Otherwise, try to describe
+in the commit header what was done and in the description why. If
+the commit is related to an issue, [make sure to reference that
+ticket.](https://man.sr.ht/git.sr.ht/#referencing-tickets-in-git-commit-messages)
+
 ## Memory model
 
-- `memory_region` is for operation-scoped memory (get,read,write)
-- `agenda_entry` is heap allocated and must be freed manually
-- Tree nodes free automatically on `free_node`
+- `memory_region` is for operation-scoped memory and gets freed
+automatically when the operation ends. Use it as much as possible
+to avoid memory leaks.
+- Tree nodes are heap allocated and must be managed manually.
 
 Avoid mixing `memory_region` pointers with global state.