github.com/grantbow/bug@v0.3.1/README.md (about)

     1  # Bug
     2  
     3  Bug is an implementation of a distributed issue tracker using
     4  git (or hg) to manage issues on the filesystem following [poor man's
     5  issue tracker](https://github.com/driusan/PoormanIssueTracker) conventions.
     6  
     7  The goal is to use the filesystem in a human readable way, similar to
     8  how an organized person without any bug tracking software might, 
     9  by keeping track of bugs in an `issues/` directory, one (descriptive)
    10  subdirectory per issue. bug provides a tool to maintain the nearest 
    11  `issues/` directory to your current working directory and provides hooks 
    12  to commit (or remove) the issues from source control.
    13  
    14  This differs from other distributed bug tracking tools, (which usually 
    15  store a database in a hidden directory) in that you can still easily 
    16  view, edit, or understand bugs even without access to the bug tool. bug
    17  only acts as a way to streamline the process of maintaining them. Another 
    18  benefit is that you can also have multiple `issues/` directories at 
    19  different places in your directory tree to, for instance, keep separate 
    20  bug repositories for different submodules or packages contained in a 
    21  single git repository.
    22  
    23  Because issues are stored as human readable plaintext files, they branch
    24  and merge along with the rest of your code, and you can resolve conflicts 
    25  using your standard tools.
    26  
    27  # Installation
    28  If you have go installed, install the latest released version with:
    29  
    30  `go get github.com/driusan/bug`
    31  
    32  Make sure `$GOPATH/bin` or `$GOBIN` are in your path (or copy
    33  the "bug" binary somewhere that is.)
    34  
    35  Otherwise, you can download a 64-bit release for OS X or Linux on the 
    36  [releases](https://github.com/driusan/bug/releases/) page.
    37  
    38  (The latest development version is on the latest v0.x-dev branch)
    39  
    40  # Sample Usage
    41  
    42  If an environment variable named PMIT is set, that directory will be
    43  used to create and maintain issues, otherwise the bug command will
    44  walk up the tree until it finds somewhere with a subdirectory named
    45  "issues" to track issues in.
    46  
    47  Some sample usage (assuming you're already in a directory tracked by
    48  git):
    49  
    50  ```
    51  $ mkdir issues
    52  $ bug help
    53  Usage: bug command [options]
    54  
    55  Use "bug help [command]" for more information about any command below
    56  
    57  Valid commands
    58  
    59  Issue editing commands:
    60  	create	  File a new bug
    61  	list	  List existing bugs
    62  	edit	  Edit an existing bug
    63  	tag	      Tag a bug with a category
    64  	relabel	  Rename the title of a bug
    65  	close	  Delete an existing bug
    66  	status	  View or edit a bug's status
    67  	priority  View or edit a bug's priority
    68  	milestone View or edit a bug's milestone
    69  
    70  Source control commands:
    71  	commit	 Commit any new, changed or deleted bug to git
    72  	purge	 Remove all issues not tracked by git
    73  
    74  Other commands:
    75  	env	 Show settings that bug will use if invoked from this directory
    76  	pwd	 Prints the issues directory to stdout (useful subcommand in the shell)
    77  	roadmap	 Print list of open issues sorted by milestone
    78  	version	 Print the version of this software
    79  	help	 Show this screen
    80  
    81  $ bug create Need better help
    82  (Your editor opens here to enter a description)
    83  
    84  $ bug list
    85  Issue 1: Need better help
    86  
    87  $ bug list 1
    88  Title: Need better help
    89  
    90  Description:
    91  The description that I entered
    92  
    93  $ bug purge
    94  Removing issues/Need-better-help
    95  
    96  $ bug create -n Need better formating for README
    97  
    98  $ bug list
    99  Issue 1: Need better formating for README
   100  
   101  $ bug commit
   102  $ git push
   103  ```
   104  
   105  # Feedback
   106  
   107  Currently, there aren't enough users to set up a mailing list, but 
   108  I'd nonetheless appreciate any feedback at driusan+bug@gmail.com. 
   109  
   110  You can report any bugs either by email, via GitHub issues, or by sending
   111  a pull request to this repo.