starfish

backend, frontend, ios engineer

GitHub 便利機能まとめ(*随時追記中)

2019-10-27GitHub

GitHubはエンジニアが開発を行うためのプラットフォームですが、ソースコードを管理する以外にも、開発を効率的に進めるための便利機能が数多く用意されています。

今回は一部の便利機能をまとめて紹介します。

便利機能

検索

リポジトリの左上にある Search or jump to... から、ファイル内検索をすることができます。

この検索の場合、リポジトリ内だけでなく、GitHub全体で自分がアクセス可能なリポジトリ全てが検索対象となります。

また、ソースコードだけでなく、wikiやissueも検索対象となります。

ファイル検索

リポジトリのトップ画面でキーボードの t を押下すると、リポジトリ内のファイル検索をすることができます。

t を押下する前にブランチを切り替えておくと、そのブランチ内で検索をすることも可能です。

リポジトリのテンプレート化

Settings -> Options -> Template repositoryにチェックを入れることで、そのリポジトリをテンプレート化することが可能です。

そのリポジトリに対してRead権限があるユーザーであれば、誰でもそのリポジトリをテンプレートとしてリポジトリを新規作成することが可能です。

テンプレートからリポジトリを作ることは、Forkすることと似ていますが、以下の点で異なります。

  • Forkの場合は親リポジトリのコミット履歴を含むが、テンプレートから作成する場合は含まない
  • Forkへのコミットはコントリビューショングラフに表示されませんが、テンプレートから作成されたリポジトリへのコミットはコントリビューショングラフに表示されます
  • Forkは、既存のプロジェクトにコードをコントリビュートするための方法となります。テンプレートからリポジトリを作成することは、新しいプロジェクトを素早く始める方法です。

Issueのテンプレート

テンプレートは用途に応じて複数種類用意することが可能です。

Settings -> Options -> Get organized with issue templates -> Set up templates を押下することでIssueのテンプレートを作成することができます。

または、 リポジトリに /.github/ISSUE_TEMPLATE のディレクトリを作成して、配下に .md ファイルをコミットすることでテンプレートの作成、編集を行うことが可能です。

ファイルの形式などは こちら を参照してください。

Saved replies

コメントの定型文を作成することが可能です。

Personal settings -> Saved replies から保存することができます。

LGTMの画像やコメントを保存すると便利です。

Pin issue

issueのトップページに常に表示させるissueを指定することができます。

重要なissueなどを指定すると良いでしょう。

Transfer issue

issueを他のリポジトリへ移動させることができます。

複数プロジェクトを担当していて、issueの作成先のリポジトリを間違えた時などに有効な機能です。