git-bug/git-bug 来源: https://github.com/git-bug/git-bug # git-bug [![构建状态][ci/badge]][ci/url] [![Open Collective 支持者][backers/badge]][oc] [![Open Collective 赞助者][sponsors/badge]][oc] [![GPL v3 许可证][license/badge]][license/url] [![GoDoc 文档][godoc/badge]][godoc/url] [![Matrix 聊天][matrix/badge]][matrix/url] [问题列表] - [文档][doc] - [讨论区][discuss] git-bug 是一个缺陷跟踪系统，它： - 完全内嵌于 git：只需你的 git 仓库即可拥有缺陷跟踪器 - 分布式：使用常规的 git 远程仓库进行协作，推送和拉取你的缺陷！ - 离线工作：在飞机上或海底？继续记录和处理缺陷吧！ - 避免供应商锁定：你常用的服务宕机或失效？你已拥有完整备份。 - 高效：列出或打开缺陷仅需毫秒级响应 - 不污染项目：不会在项目中添加任何文件 - 集成现有工具链：使用你喜欢的界面（CLI、终端、Web）或通过 CLI 或 GraphQL API 与现有工具集成 - 桥接其他缺陷跟踪器：使用桥接功能导入导出到其他跟踪器。 ## 安装指南 完整安装指南请参阅 [安装文档][doc/install]，包含从源码构建和验证安装的方法。 ## 工作流程 git-bug 提供多种使用方式，详见 [工作流程文档][doc/usage/workflows]。 原生工作流程 这是纯粹的 git-bug 体验。类似代码管理方式，使用 git bug push 和 git bug pull 在 git 远程仓库间同步缺陷，并与团队成员协作。 桥接工作流程 由于 git-bug 具备与其他缺陷跟踪器的桥接功能，可将其作为个人本地远程接口。通过 git bug bridge pull 和 git bug bridge push 进行同步，你可以在终端操作，集成到编辑器中，灵活掌控。且支持离线工作！ Web 界面工作流程（开发中） 项目通常需要公开缺陷跟踪器并接受用户反馈。为此，git-bug 致力于实现 Web 界面支持外部 OAuth 认证并作为公共门户。但当前 Web 界面尚未完成，欢迎贡献！ ## 命令行使用 创建新身份： shell git bug user create 创建新缺陷： shell git bug add 系统将打开默认编辑器，用于输入标题和描述。可将新条目推送到远程仓库： shell git bug push [] 拉取更新： shell git bug pull [] 列出现有缺陷： shell git bug ls 使用[查询语法][doc/usage/query]筛选和排序缺陷： shell git bug ls "status:open sort:edit" 按文本内容搜索缺陷： shell git bug ls "foo bar" baz 现在可以使用 show、comment、open 或 close 等命令查看和修改缺陷。各命令详细说明请运行 git bug --help 或参阅 [命令文档][doc/cli]。 ## 交互式终端界面 通过命令 git bug termui 可使用交互式终端界面浏览和编辑缺陷。终端界面演示 ## Web 界面 执行 git bug webui 可启动功能丰富的 Web 界面。支持浏览、搜索、筛选缺陷，创建新缺陷、评论、编辑标题/标签/状态。同时集成代码浏览功能，提供文件树、语法高亮、提交历史与差异比较。Web 界面打包在同一个 Go 二进制文件中，通过本地 HTTP 服务器提供服务。与后端的交互采用 GraphQL API，接口定义位于 [此处][gql-schema]。 ## 桥接功能 git-bug 支持从 Github、Gitlab、Jira、Launchpad 导入导出数据。各桥接功能支持范围请查看[功能矩阵][doc/feature-matrix]，完整指南参阅[桥接文档][doc/usage/bridges]。 交互式配置新桥接： shell git bug bridge new 或手动配置： shell git bug bridge new \ --name= \ --target=github \ --url=https://github.com/git-bug/git-bug \ --login= \ --token= 导入缺陷： shell git bug bridge pull [] 导出修改： shell git bug bridge push [] 删除桥接： shell git bug bridge rm [] ## 技术原理 想了解实现原理？请参阅[数据模型][doc/design/model]和[架构概览][doc/design/arch]。磁盘存储格式在 [git-bug 规范][spec] 中正式定义，包含 DAG 实体格式、身份标识和缺陷实体规范。如需开发其他实现或直接读取 git-bug 数据的工具，请阅读该规范。或许你也想在 git 中构建自己的分布式数据结构？完整文档请查阅[文档中心][doc]。 ## 杂项 - Bash、Zsh、fish、PowerShell 补全脚本 - 手册页 ## 计划功能 [功能矩阵][doc/feature-matrix] 展示了主要规划方向，以下为其他计划功能： - 可作为公共门户接收用户反馈的 Web 界面 - 可充气的迅猛龙模型（项目吉祥物）## 贡献指南 欢迎提交 PR！加入 [Matrix 聊天室][matrix/url] 参与讨论，查看[功能矩阵][doc/feature-matrix]或浏览[问题列表]与[讨论区][discuss]了解开发动态。请参阅 [贡献指南][contrib] 搭建开发环境、构建项目及运行测试。Web 界面开发请参考专用说明文档。 ## 贡献者 :heart: 感谢所有贡献者使本项目得以存在。 ## 支持者与赞助商 感谢所有支持者和赞助商！ 🙏 [[成为支持者或赞助商][oc]] ## 许可证 除特别说明外，本项目采用 [GPLv3][license/url] 或更新版本许可 © Michael Muré。 git-bug 标志由 [Viktor Teplov][gh/vandesign] 设计，采用 [知识共享署名 4.0 国际协议 (CC BY 4.0)][license/logo] 许可 © Viktor Teplov。 [backers/badge]: https://opencollective.com/git-bug/backers/badge.svg [ci/badge]: https://github.com/git-bug/git-bug/actions/workflows/trunk.yml/badge.svg [ci/url]: https://github.com/git-bug/git-bug/actions/workflows/trunk.yml [contrib]: ./CONTRIBUTING.md [discuss]: https://github.com/git-bug/git-bug/discussions [doc]: ./doc [doc/cli]: ./doc/md/git-bug.md [doc/design/arch]: ./doc/design/architecture.md [doc/design/model]: ./doc/design/data-model.md [doc/feature-matrix]: ./doc/feature-matrix.md [doc/install]: ./INSTALLATION.md [doc/usage/bridges]: ./doc/usage/third-party.md [doc/usage/query]: ./doc/usage/query-language.md [doc/usage/workflows]: ./doc/usage/workflows.md [gh/vandesign]: https://github.com/vandesign [godoc/badge]: https://godoc.org/github.com/git-bug/git-bug?status.svg [godoc/url]: https://godoc.org/github.com/git-bug/git-bug [gql-schema]: ./api/graphql/schema [issues]: https://github.com/git-bug/git-bug/issues [license/badge]: https://img.shields.io/badge/License-GPLv3+-blue.svg [license/logo]: ./misc/logo/LICENSE [license/url]: ./LICENSE [matrix/badge]: https://img.shields.io/badge/chat%20on%20matrix-%23238636 [matrix/url]: https://matrix.to/#/#git-bug:matrix.org [oc]: https://opencollective.com/git-bug [spec]: https://github.com/git-bug/spec [sponsors/badge]: https://opencollective.com/git-bug/sponsors/badge.svg