Git-bug: Gitに埋め込まれた分散型オフラインファーストのバグトラッカー
Git-bug: Distributed, offline-first bug tracker embedded in Git (github.com)
要約
Git-bugは、Gitリポジトリに統合された分散型のバグトラッカーです。Gitの通常のリモートを使用してバグを共同作業、プッシュ、プルでき、オフラインでも作業可能です。ベンダーロックインを防ぎ、プロジェクトを汚染せず、ミリ秒単位で高速に動作します。CLI、ターミナルUI、Web UI、GraphQL APIを通じてツールと統合でき、GitHub、GitLab、Jira、Launchpadなどの他のバグトラッカーへのブリッジも提供しています。
全文翻訳
git-bug
git-bug は、以下のような特徴を持つバグトラッカーです。
- Gitに完全に統合: バグトラッカーを持つために必要なのは、あなたのGitリポジトリだけです。
- 分散型: 通常のGitリモートを使用して、バグを共同作業し、プッシュ・プルできます!
- オフラインで動作: 飛行機の中や海の下でも? バグの読み書きを続けましょう!
- ベンダーロックインを防止: いつも使っているサービスがダウンしたり、調子が悪くなったりしても? あなたはすでに完全なバックアップを持っています。
- 高速: バグのリスト表示やオープンはミリ秒単位です。
- プロジェクトを汚染しない: プロジェクトにファイルが追加されることはありません。
- ツールとの統合: 好みのUI(CLI、ターミナル、Web)を使用するか、CLIまたはGraphQL APIを通じて既存のツールと統合します。
- 他のバグトラッカーへのブリッジ: ブリッジを使用して、他のトラッカーへのインポートとエクスポートが可能です。
インストール
ソースからのビルドやインストールの検証方法を含む完全なガイドについては、INSTALLATION.md を参照してください。
ワークフロー
git-bug の使い方は複数あります。詳細はワークフローのドキュメントを参照してください。
ネイティブワークフロー
これは純粋なgit-bug体験です。コードの場合と同様に、git bug push と git bug pull を使用して、Gitリモート間でバグをプッシュ・プルし、チームメイトと共同作業します。
ブリッジワークフロー
git-bug には他のバグトラッカーとのブリッジがあるため、個人のローカルリモートインターフェースとして使用できます。git bug bridge pull と git bug bridge push で同期し、ターミナルから作業したり、エディタに統合したり、すべてあなた次第です。そして、オフラインでも動作します!
Web UIワークフロー (WIP)
プロジェクトでは、バグトラッカーを公開し、問題に直面した誰からの編集も受け付ける必要があることがよくあります。このワークフローをサポートするために、git-bug はWeb UIが外部OAuth認証を受け入れ、公開ポータルとして機能することを目指しています。ただし、Web UIはまだそこまで追いついていません。貢献を大歓迎します!
CLIの使用法
新しいIDを作成します:
git bug user create
新しいバグを作成します:
git bug add
お気に入りのエディタが開き、タイトルとメッセージを記述できます。
新しいエントリをリモートにプッシュできます:
git bug push [<remote>]
更新のためにプルします:
git bug pull [<remote>]
既存のバグをリスト表示します:
git bug ls
クエリを使用してバグをフィルタリングおよびソートします:
git bug ls "status:open sort:edit"
テキストコンテンツでバグを検索します:
git bug ls "foo bar" baz
これで、show、comment、open、close などのコマンドを使用してバグを表示および変更できます。各コマンドの詳細については、git bug <command> --help を実行するか、コマンドのドキュメントをお読みください。
インタラクティブターミナルUI
git bug termui コマンドを使用して、バグをブラウズおよび編集するためのインタラクティブなターミナルUIが利用可能です。
Web UI
git bug webui でリッチなWeb UIを起動できます。問題をブラウズ、検索、フィルタリングし、新規作成、コメント、タイトル、ラベル、ステータスの編集が可能です。リポジトリのコードブラウザとしても機能し、ファイルツリー、シンタックスハイライトされたファイル、コミット履歴、差分を表示します。
[画像: An issue with its comments and timeline]
[画像: Browsing the repository code]
Web UIは同じGoバイナリ内にパッケージ化されており、ローカルHTTPサーバーによって提供されます。バックエンドとはGraphQL APIを通じて通信し、そのスキーマはこちらで利用可能です。
ブリッジ
git-bug は、Github、Gitlab、Jira、Launchpad からインポートおよびエクスポートできます。各ブリッジがサポートする機能については、機能マトリックスを参照し、完全なガイドについてはブリッジのドキュメントを参照してください。
新しいブリッジをインタラクティブに設定します:
git bug bridge new
または手動で:
git bug bridge new \
--name=<bridge> \
--target=github \
--url=https://github.com/git-bug/git-bug \
--login=<login> \
--token=<token>
バグをインポートします:
git bug bridge pull [<name>]
変更をエクスポートします:
git bug bridge push [<name>]
ブリッジを削除します:
git bug bridge rm [<name>]
内部構造
仕組みに興味がありますか?データモデルと内部バードビューをご覧ください。
ディスク上のフォーマットは、DAGエンティティフォーマット、ID、およびバグエンティティをカバーするgit-bug specで正式に指定されています。別の実装を作成したり、git-bugデータを直接読み取るツールを作成したい場合は、これを読んでください。
あるいは、Gitで独自の分散データ構造を作成したいですか?
また、すべてのドキュメントも参照してください。
その他
計画中の機能
機能マトリックスは、網羅的ではありませんが、計画されていることの概要を把握するのに役立ちます。
追加の計画中の機能:
- ユーザーの入力を受け付ける公開ポータルとして使用できるWeb UI
- 膨らむラプター
貢献
PR(プルリクエスト)を受け付けています。チャットはMatrixルームでどうぞ。作業中または議論中の内容を確認するには、機能マトリックスを参照するか、イシューおよびディスカッションをご覧ください。
開発環境のセットアップ、プロジェクトのビルド、テストの実行方法については、CONTRIBUTING.mdを参照してください。Web UIで作業するには、専用のREADMEをご覧ください。
貢献者 ❤️
このプロジェクトは、貢献してくれたすべての人々のおかげで存在しています。
バックサポーター&スポンサー
すべてのバックサポーターとスポンサーに感謝します!🙏
バックサポーターまたはスポンサーになる
ライセンス
特に記載がない限り、このプロジェクトはGPLv3(またはそれ以降)のライセンスでリリースされています © Michael Muré。
Viktor Teplovによるgit-bugロゴは、Creative Commons Attribution 4.0 International (CC BY 4.0) ライセンスでリリースされています © Viktor Teplov。