aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 9 insertions, 0 deletions
diff --git a/README b/README
index c75e205..b084a49 100644
--- a/README
+++ b/README
@@ -165,6 +165,15 @@ should make filing new notes a fairly burdenless process: write a note using
your favorite text editor and run the add script. Note that the add script
currently cannot handle notes with extra files.
+If you change an existing note (for example, add additional information), then
+the commit message should have the following form:
+
+Update <type>: <summary>
+
+For example:
+
+Update idea: Implement pluggable formatter
+
Once a note is acted upon (implemented or you have decided not to do anything
about it), you can either delete it or move it to the reference. Simply
deleting a note is appropriate for simple bugs and features where all the