diff options
Diffstat (limited to 'README.cli')
| -rw-r--r-- | README.cli | 19 |
1 files changed, 12 insertions, 7 deletions
@@ -107,7 +107,7 @@ a new feature), \c{quality} (improve quality of implementation), \c{infra} Further, labels can be used to group notes based on certain criteria. For example, \c{doc} (documentation issue), \c{windows} (Windows-specific), \c{2.0.0} (scheduled for the 2.0.0 release), \c{john} (assigned to John). The -names of subdirectories in which the issue is located are also considered its +names of subdirectories in which the note is located are also considered its labels. So, for example, if the above \"Detect empty name\" bug was filed in \c{lihello/format/}, then its labels would be \c{bug}, \c{format}, and \c{libhello}. @@ -189,12 +189,13 @@ For example: Add bug: Detect empty name \ -If you only have a single issue added in the database then you can use the -\c{add} script to automate it. This script will commit the new issues with the -correct message and, unless the \c{-c} option is specified, push the result to -\c{origin}. This should make filing new notes a fairly burdenless process: -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 only have a single note added in the database then you can use the +\c{add} script to automate this. This script will commit the new note with +the correct message and, unless the \c{-c} option is specified, push the +result to \c{origin}. This should make filing new notes a fairly burdenless +process: 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: @@ -209,6 +210,10 @@ For example: Update idea: Implement pluggable formatter \ +Similar to adding, if you only have a single note updated in the database then +you can use the \c{update} script to automate this. Note that the \c{update} +script currently cannot handle updates with extra files. + 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 |