diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2016-09-27 06:42:36 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2016-09-27 07:04:54 +0200 |
| commit | 31cb850c04873e29ad1ff5a5d5255283827907b2 (patch) | |
| tree | 59469c23704ee637f6c23982c2cf68168d42408d /README | |
| parent | 01ee7236a462b07b7e45bb4800920ba1bef88c65 (diff) | |
Diffstat (limited to 'README')
| -rw-r--r-- | README | 14 |
1 files changed, 9 insertions, 5 deletions
@@ -85,9 +85,9 @@ infrastructure). Further, labels can be used to group notes based on certain criteria. For example, doc (documentation issue), windows (Windows-specific), 2.0.0 (scheduled for the 2.0.0 release), john (assigned to John). The names of -subdirectories in which the issue is located are also considered its labels. -So, for example, if the above "Detect empty name" bug was filed in -lihello/format/, then its labels would be bug, format, and libhello. +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 lihello/format/, +then its labels would be bug, format, and libhello. The body of a note is free-form. However, for clarity, it makes sense to avoid using '-' for lists in the body ('*' for the first level and '~' for the second @@ -158,8 +158,8 @@ For example: Add bug: Detect empty name -If you only have a single issue added in the database then you can use the add -script to automate it. This script will commit the new issues with the correct +If you only have a single note added in the database then you can use the add +script to automate this. This script will commit the new note with the correct message and, unless the -c option is specified, push the result to origin. This 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 @@ -174,6 +174,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 update script to automate this. Note that the 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 |