From 1c6a06032265e4085f8975a384fe170419f9f937 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Tue, 27 Sep 2016 05:04:47 +0200 Subject: Document note update commit message --- README | 9 +++++++++ README.cli | 13 +++++++++++++ 2 files changed, 22 insertions(+) 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 : + +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 : +\ + +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 -- cgit v1.1