git-bug/Readme.md
2018-07-16 14:53:32 +02:00

1.3 KiB

git-bug

Bugtracker embedded in Git

Would it be nice to not have to rely on a web service somewhere to deal with bugs ?

Would it be nice to be able to browse and edit bug report offline ?

git-bug is a bugtracker embedded in git. It use the same internal storage so it doesn't pollute your project. As you would do with commits and branches, you can push your bugs to the same git remote your are already using to collaborate with other peoples.

🚧 This is for now a proof of concept. Expect dragons and unfinished business. 🚧

Install

go get github.com/MichaelMure/git-bug

If it's not done already, add golang binary directory in your PATH:

export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

That's all !

Usage

It's really a WIP but you can already create a bug:

git bug new "This doesn't even build"

Your favorite editor will open to write a description.

You can push your new entry to a remote:

git bug push [<remote>]

And pull for updates:

git bug pull [<remote>]

Internals

Interested by how it works ? Have a look at the data model.

Planned features

  • interactive CLI UI
  • rich web UI
  • media embedding
  • import/export of github issue
  • inflatable raptor

Contribute

PRs accepted.

License

GPLv3 or later © Michael Muré