aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-09-27 05:04:47 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-09-27 05:04:47 +0200
commit1c6a06032265e4085f8975a384fe170419f9f937 (patch)
treead5de23d930eb270164406286e6a8cd7298fd82a
parent9f659c6a62d7f97f58a84b9dc4e4fc2d1a626824 (diff)
Document note update commit message
-rw-r--r--README9
-rw-r--r--README.cli13
2 files changed, 22 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
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