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