Git-bug: Distributed, offline-first bug tracker embedded in Git

Git-bug is a distributed, offline-first bug tracker that can be embedded within Git. The installation instructions, including building from source and verifying the installation, are detailed in the INSTALLATION.md file. Various ways to utilize git-bug are outlined in the workflow documentation.

Git-bug operates similarly to version control systems, with the commands git bug push and git bug pull used to synchronize bugs between Git repositories and collaborate with teammates. The bridge functionality enables git-bug to interface with other bug-tracking systems, such as GitHub, GitLab, Jira, and Launchpad, allowing for seamless synchronization.

Collaboration takes place in the terminal, with users able to view and edit bugs using commands like show, comment, open, or close. An interactive terminal UI, accessible via git bug termui, and a rich web UI, accessible through git bug webui, are both available for browsing, searching, and filtering issues, as well as creating new ones, commenting, and editing titles, labels, and statuses.

The web UI serves as a code browser for the repository, featuring a file tree, syntax-highlighted files, commit history, and diffs. The web UI is embedded within the same go binary and served by a local HTTP server, communicating with the backend through a GraphQL API. The schema for this API is available for reference.

Git-bug's data model and internal workings are formally specified in the git-bug spec, covering the DAG entity format, identities, and bug entities. This information is valuable for developers interested in creating alternative implementations or tools that can directly read git-bug data. The project welcomes contributions, with feature plans outlined in the feature matrix.

Contributors are encouraged to join the Matrix room for discussions, review the feature matrix, and explore the issues and discussions section. Detailed instructions for setting up a development environment, building the project, and running tests can be found in the CONTRIBUTING.md file. The git-bug logo, designed by Viktor Teplov, is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) license.