aboutsummaryrefslogtreecommitdiff
path: root/README.cli
diff options
context:
space:
mode:
Diffstat (limited to 'README.cli')
-rw-r--r--README.cli13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.cli b/README.cli
index 63c2e2f..2ca9e55 100644
--- a/README.cli
+++ b/README.cli
@@ -196,6 +196,19 @@ correct message and, unless the \c{-c} option is specified, push the result to
write a note using your favorite text editor and run the \c{add} script. Note
that the \c{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