Githubは、現代の開発者の生活の重要な部分です。Githubは、オープンソースプロジェクトをホストするための標準になっています。「2GIS」では、Web部門プロジェクトの開発とオープンソースプロジェクトのホスティングにgithubを使用しています。

私たちのほとんどはほぼ毎日このサービスを使用していますが、仕事や日常業務を容易にするためのチップがたくさんあることを誰もが知っているわけではありません。たとえば、URLから公開キーを取得します。ユーザーがリポジトリにアクセスするサイトの追跡。 githubリポジトリにあるファイルへのリンクの正しい共有。ホットキーなど。この記事の目的は、非自明なことと、一般的にgithubでの作業をより生産的で楽しいものにすることについて話すことです（このトピックは別の記事に値するので、ここでgithub APIを使用することは考えません）。

内容

URLの秘cks

Githubの哲学はシンプルであると同時に、非常に柔軟なツールになることです。このため、多くの機能はユーザーインターフェイスから使用できませんが、URLパラメーターを介してアクセスできます。

公開鍵アクセス

githubアカウントを持っている同僚のsshアクセスを構成する場合、最も簡単な方法は、 https： //github.com/ <user_name> .keys（たとえば、 https：/ /github.com/defunkt.keys ）。この機能を使用してCIプロセスを設定している場合、常に最新の公開キーを使用できます。

差分とパッチへのアクセス

コミットまたはプルリクエストURLページの最後に.diff

または.patch

を追加すると、この出力をdiffまたはパッチUNIXユーティリティの形式で取得できます（たとえば、 https：//github.com/tars/の形式のURLを使用します） tars / commit / 07902a956da92e6a616a69d3b3f0f9276f0c13fe.diff-末尾の「.diff」に注意してください）。このように、キャッシュデスクを離れずに一連の変更を取得してSlackまたはメールで送信すると便利な場合があります。

リポジトリ内のファイルへのURLの共有

ここでは、一見、すべてが簡単です。ブラウザーのアドレスバーからファイルへのリンクをコピーし、必要に応じて貼り付けました。しかし、プロジェクトの動的な性質により、コミットは常にウィザードに追加され、ファイルの内容は将来変更されるか、ファイルが完全に削除される可能性があるため、ブラウザのアドレスバーの通常のコピーはここでは適切ではありません。ファイルの現在のバージョンへの永続的なリンク（永続的なリンク -Githubが呼び出すように）を取得するには、URLのブランチ名の代わりにコミットハッシュを使用する必要があります。はい、これはかなり不便なので、githubのメンバーがホットキーを作成しました。ファイルを表示しているときに「y」を押します-ブラウザのURLはパーマネントリンクに変更されます。

差分を表示するときに空白文字を除外する

ファイルの違いを表示するときにURLに?w=1

を追加し?w=1

違いがスペースのみであった場合、これは気を散らしません。

特定のコードブロックを強調表示する

ファイルを表示するときに、その行のいずれかをクリックして、指定された場所へのリンクを送信できます。一連の行を選択するには、次のように、範囲の最後の行番号をマイナス記号から行番号の後にURLに追加します（URLの最後でL30-L32に注意してください）： https : //github.com/torvalds/linux/blob/9256d5a308c95a50c6e85d682492ae1f86a70f9b /include/uapi/linux/netfilter_bridge/ebt_among.h#L30-L32

リポジトリ内のブランチリビジョンの比較

プルリクエストを作成するとき、マージの結果としてどの変更がターゲットブランチに分類されるかをすぐに確認できます。ただし、ブランチ比較ページには明らかな機能があります。たとえば、2週間など、特定の期間のブランチのすべての変更を確認できます-https: //github.com/github/linguist/compare/master@%7B2week%7D...master 。ブラウザーに比較ページをブックマークしておくと便利な場合があります。何か問題が発生した場合は、たとえば過去24時間にわたってコードの変更点をすばやく確認します（「master @ {1day} ... master）。標準のgit diffはこの機能の内部で使用されるため、gitが受け入れる任意の時間形式を使用できます。ブランチ、コミットなどの比較の詳細については、ドキュメントを参照してください。

ホットキー

個人的に、私はホットキーの大ファンです。標準的なアクションを実行するときに時間を節約し、子供の運動能力を養います。 githubには多くのホットキーがあり、最も便利なものについて説明します。

ファジーファイル検索のアクティブ化

リポジトリの表示中に「t」を押すと、ファイル検索行が表示され、パスの一部を入力して目的のファイルを選択できるため、検索でリポジトリをさまよっている時間を節約できます。

ファイル内の特定の行へのクイックジャンプ

ファイルを表示しているときに「 l

」を押します-行番号を入力するための小さなウィンドウが表示されます。

Githubセクションへのクイックジャンプ

これらの組み合わせは覚えやすいです。接頭辞「g」（go）で始まり、それに続く文字は宛先を示します。 gp-プルリクエストリストに移動、gi-課題リスト、gn-通知ページなど。

このホットキーリストは完全にはほど遠いです。利用可能なすべてのホットキーを表示するには、「？」をクリックします。

チケットとプルリクエスト

問題とプルリクエストは、プロジェクト管理の絶え間ない支援者です。 Githubには、それらと連携するための多くのツールが用意されています。ラベルシステムを使用して、各チケットまたはプルリクエストに対応する属性（機能、バグ、ドキュメントなど）を付加できます。また、マイルストーンを作成して、どのバージョンのどのチケットで作業が実行されるかを示すこともできます。そして、楽しくて役に立つトリックがいくつかあります。

コミットを使用して問題を自動的に閉じる

リポジトリのメインブランチに分類されるコミットのテキストに、さまざまなバリエーションの fix / resolve / closeという単語と、「＃」記号の後のチケット番号が含まれている場合、対応する番号のチケットが閉じられます。

つまり、次のメッセージでコミットします。

 $ git commit -m "Fix screwup, fixes #12"

この結果につながります：

お気に入りのプルリクエストとチケットを検索する

この機能は、githubがコメントに反応を追加したときに比較的最近登場しました。並べ替えでは、反応に含まれる絵文字の数を考慮することができます。したがって、ソート用の絵文字のタイプは、「ソート」メニューで選択できます。

Githubマークダウン

githubは、コメントおよびマークダウンファイルで使用されるマークダウンマークアップのスーパーセットを使用します。これを使用して、リポジトリまたは課題間のクロスリンクを作成し、To Doリストを作成し、コードを強調表示できます。

クロスリンク

チケット（問題）を作成するときに別のチケットに言及する必要がある場合は、「＃」記号を入力できます。必要なチケットを選択できるメニューが表示されます。自分でチケット番号を書くこともできます。リンクとともにコメントを保存すると、対応するメッセージが前述のチケットのページに表示されます。プライベートリポジトリから別のチケットに言及した場合、言及はこのリポジトリにアクセスできる人にのみ表示されます。同時に、ハッシュを指定するだけで、発行するだけでなく特定のコミットへのリンクを作成できます-Githubは自動的に正しいリンクに変換します。

構文の強調表示

マークダウンマークアップでコードの一部を強調表示するには、コードブロックの前のトリプルバックティックとブロックの最後のトリプルバックティックの後に言語の名前を入力します。

 ```javascript function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } } ```

予定リスト

予定リストの構文は次のとおりです。

 - [x] @mentions, #refs, [links]() - [x] list syntax required (any unordered or ordered list supported) - [x] this is a complete item - [ ] this is an incomplete item

リスト付きのコメントを保存すると、マーク可能なチェックボックス付きのタスクの完全なリストになります（対応する[x]がマークダウンマークアップに自動的に表示されます）。リストを操作する良い例は次のとおりです。https ： //github.com/neovim/neovim/pull/243

一般的には、 GitHub風味のマークダウンであるgithubのヘルプを必ず確認してください。さらに興味深いトリックがいくつかあります。

アカウント

二要素認証とセキュリティ

ここで議論することはあまりありません-まだ有効にしていない場合は有効にしてください。このオプションは[設定]-> [セキュリティ]にあります。ちなみに、そこにはアカウントのセキュリティに関連するアクションの全履歴（過去のセッションのリスト、IPアドレスなど）を見ることができます。

複数のメールアドレスを1つのアカウントにリンクする

仕事用と個人用の通信に複数のアドレスを使用する場合、Gitレベルでそれらを区切って、1つの電子メールで作業プロジェクトにコミットし、別の電子メールでホームプロジェクトにコミットすると便利です。 github上のすべての通信用に特別なボックスを作成できます。すべての場合に問題が発生します。サービスメトリックは、登録が発生したメールボックス以外のメールボックスでのコミットを受け入れません。これを回避するには、プロファイルに関連付けられるすべての電子メールアドレスを指定します（ [設定]-> [電子メール] ）。情報の更新には時間がかかることに注意してください。

aivusからの補足：

これらの電子メールを確認すると、彼らの助けを借りてアカウントにアクセスできるようになります（パスワード回復）。パスワード回復機能を使用せずにアカウントとメールの関連付けを行いたい場合は、このボックスを確認しないでください。サポートgithubはまさにそれを行うことを勧めました。

保存された返信

この機能は、プルリクエストまたはチケットに同じタイプのコメントを頻繁に書き込むユーザーに特に役立ちます。たとえば、プルリクエストはContributor.mdで定義されたルールに準拠する必要があります。一連の回答を保存して、Githubエディターメニューからすばやく貼り付けることができます。

回答を追加するページは次のとおりです。設定->返信を保存しました。

言及

メカニックで人気のあるこの機能は、ハブやTwitterでの言及に似ています。コメントを作成するときは、「@」文字を入力し、その直後にユーザーのニックネームを入力します。言及されたユーザーは、言及された通知ページでチケットまたはプル要求への対応するリンクを受け取ります。

メンションは、特定のユーザーだけでなく、組織内のユーザーのグループでも利用できます。この場合、「@」の後に組織の名前を入力し、スラッシュの後にチームの名前を入力する必要があります（例：@ 2gis / mamonts）。新しいチームの追加は、組織のホームページの[チーム]タブから利用できます。

Githubメールアラート

設定でメールアラートを有効にしている場合、メールクライアントを離れることなく、githubでのディスカッションに参加できます。メールに返信すると、対応するチケットまたは送信されたレターのコンテンツを使用したプルリクエストで、ユーザーに代わってgithubにコメントが作成されます。

パブリックユーザーアクティビティを購読する

Githubの特定のユーザーに興味がある場合は、そのユーザーをフォローして（ユーザープロファイルページの[フォロー]ボタン）、サイトのメインページの一般リストで彼の公開アクティビティ（コミット、コメントなど）を確認できます。メインページには過去3日間のスライスしか表示できないため、すべてのユーザーアクティビティをスキップしたくない場合は、https：//github.com/ <user_name> .atomのようなリンクを使用してサブスクライブできるrssフィードが必要になります。同様に、組織のすべてのパブリックアクティビティ（ https://github.com/2gis.atomなど）にサブスクライブできます。

リポジトリを操作する

Githubサービスのディレクトリとファイル

プロジェクトのルートにreadmeファイルがある場合、ファイルのリストの下にその内容が表示されます。これは多くの人に知られています。しかし、プロジェクトを改善するための推奨事項を含むContributor.mdファイルを作成すると、プルリクエストの作成またはチケットを開くためのページにリンクが表示されることを誰もが知っているわけではありません。

code.google.comを閉じた後、多くのプロジェクトがGithubに移行しました。この点で、サービスを改善するための多くのリクエストがgithubに落ちました（はい、これは単なる推測ですが、このイベントはある程度触媒として機能する可能性があります）。要求の1つは、チケットを開くときにテンプレートを作成することでした。最近、github はこの機会を実現しました。

プロジェクトルート内にISSUE_TEMPLATEという名前のファイルを作成すると、新しいチケットを開くときにその内容が入力フィールドに自動的に挿入されます。同じことがプールリクエストでも機能します。この場合、ファイルはPULL_REQUEST_TEMPLATEと呼ばれるべきです。ファイルはマークダウン形式にすることができます。

以下は、Reactリポジトリーのサンプルテンプレートです（ https://github.com/facebook/react/blob/20bcabb1ea4cf492ade240bd6915b4bd44f04895/.github/ISSUE_TEMPLATE.md）。リポジトリでチケットを開こうとすると、テキスト入力フィールドにはすでに有用な情報が入力されています。

サービスファイルでプロジェクトのルートを大きく詰まらせないために、.github /ディレクトリを作成し、そこにGithubに関連するすべてのファイルを配置できます。これらのファイルに関連付けられているすべての機能は以前と同様に機能します。

プログラミング言語統計

このリポジトリで使用される言語の統計ページは、色付きのバーの形でリポジトリのメインページに表示されます。クリックすると、パーセンテージが表示されます：

プロジェクトで大きなjsフレームワークを使用し、リポジトリの統計でお気に入りのGo / Python / Java / Rubyの70％を食べたくない場合は、vendorsディレクトリを作成し、考慮に入れないすべての依存関係をそこに配置しますgithub統計システム。または、ここで統計で削除するファイルまたはディレクトリの可用性を確認します-何もする必要がない可能性が十分にあります

はい、プロジェクト内の言語が定義どおりに定義されていない場合、この場合は言語学者を調べる価値があります。 Linguistはgithubが使用言語の統計を収集するルビーライブラリです。プロジェクトのreadmeは、定義されたファイルをオーバーライドするさまざまな方法を説明しています。

リポジトリメトリック

Githubは、リポジトリで行われている作業を追跡するための多くのメトリックを提供します。関連する監視ツールは、[パルス]タブと[グラフ]タブにあります。 Pulseは、ある期間にわたってリポジトリで何が起こったかを示します。 [グラフ]セクションでは、さまざまなインジケータがグラフに表示されます。リポジトリ所有者の場合、「トラフィック」サブアイテムも「グラフ」タブに表示されます。概して、これはリポジトリのミニGoogleアナリティクスです。リポジトリ内にいたユーザーの数とアクセス元を追跡できます。

新しいリポジトリを作成する

リポジトリを作成するときに、必要なgitignoreファイル、プロジェクトのライセンス、readmeファイルに空白が必要かどうかをすぐに選択できます。したがって、プロジェクト準備の初期段階で少し時間を節約できます。

プロジェクトのタイプがgitignoreリストにない場合は、この状況を改善し、 gitignore githubリポジトリにプルリクエストを提供する必要があります。

コード検索

githubの別の非自明な機能は、すべてのリポジトリでの高度なコード検索です： https : //github.com/search ：

本格的な検索サービスと同様に、高度な検索ページに移動して、ユーザー名、作成日、コードが記述されている言語などの追加パラメーターを指定できます。

検索時に、GitHubでプロジェクトを実施していて、サービスにコードのインデックスを作成したい場合（または、逆にしたくない場合）に考慮する必要がある制限があります：メインリポジトリブランチのみがインデックス付けされます（通常、これはマスターです）; 384 KBより小さいファイルのみがインデックス付けされます。 500,000ファイル未満のリポジトリのみがインデックス付けされます。

コマンドラインとGithub

ハブ

ハブは、githubの作成者によるコンソールユーティリティ（git + hub = github）であり、その目的は、シェルからのサービスの使用を容易にすることです。基本的に、ハブは標準のgitをラップし、リポジトリ、プルリクエスト、チケットを操作するための追加コマンドを提供します。

これは、リポジトリを複製する方法です。

 $ hub clone github/hub

フォークを作ります：

 $ hub fork

プルリクエストを開く：

 $ hub pull-request

ユーティリティの作成者は、ハブコマンドは標準のgitコマンドと競合しないため、インストール後にgitを呼び出すときにハブでエイリアスを作成することをお勧めします（alias git = hub）。

ユーティリティの使用に関する詳細は、manまたはプロジェクトのWebサイトで見つけることができます。

プルリクエストは既にリポジトリにあります。

少数の人が知っている興味深い点。プルリクエストは概して特別なブランチであるため、プルリクエストを作成すると、それに含まれるすべての変更が自動的にリポジトリに分類されます。この機能により、元のフォークが削除された場合でも、githubはプルリクエストの変更を表示できます。したがって、常にそれらにアクセスできます。プルリクエストからの変更を新しいブランチ（new_branch）に分類するには、次のコマンドを実行する必要があります。

 $ git fetch origin pull/<pr_num>/head:new_branch

ここで、<pr_num>はURLからのプルリクエスト番号です。

ユーザースクリプト

ユーザースクリプトは、特定のサイト/ Webアプリケーションを変更し、外観を変更したり、新しい機能を追加したりするユーザーJavaScriptコードです。 githubで動作するように設計されたスクリプトはかなりあります。カタログには多くの古いスクリプトがありますが、それらのいくつかは非常に現代的で便利です。

Githubが空白をコミットする

Github Commit Whitespaceは、変更された空白をdiffからすばやく削除できるリンクを比較ページに追加するだけです。

Githubニュースフィードフィルター

Githubニュースフィードフィルターは、多くのアクティブなリポジトリ/ユーザーを監視（監視）するユーザーに特に役立ちます。次のスクリプトは、イベントフィードを使用してメインページにフィルターを追加し、目的のアクティビティのみを表示できるようにします。

Github破壊行為

ギッフィティ

はい、これは効果的な作業に関するものではなく、機知に富んだ開発者が楽しみのために使用するものに関するものです。つまり、これらは、年間を通して貢献度を示す小さな四角形です-貢献度グラフ：

gitリポジトリを操作し、特定の日付に特定の量のコミットを追加することにより、ダイアグラムをわずかに多様化できます。たとえば、次のように：

もちろん、誰も彼の手でそれをしません。これを行うために、事前に定義された画像テンプレートと独自の画像テンプレートを使用する機能を備えた素晴らしいgitfitiチャートジェネレーターがあります。

コミットの作成者を置き換える

gitでは、コミットの作成者を次の方法で修正できます。

 $ git commit --amend --author="Linus Torvalds <torvalds@linux-foundation.org>"

その結果、githubのコミットが新しい作者と彼のアバターと共に表示されます：

特に4月にGithubがGPG署名にコミットの作成者の認証を追加したため、これに問題はありません。コミットの横に「検証済み」という単語が表示される場合、コミットの作成者はこの特定の人であり、他の人ではありません。

追加のGithubリソース

リポジトリの評価

新しいツールとライブラリのソースはhttps://github.com/exploreです。リポジトリのさまざまなコレクション、フォローしている人によってお気に入りに追加されたリポジトリ、そしてもちろん、最近最も人気のあるリポジトリがあります。

サービス状況

非常にまれですが、githubが不安定になることがあります。何がうまくいかなかったかを知ることができる主なリソースはhttps://status.github.com/です。そこで、githubのヘルスステータスとサービス停止に関するすべてのアラートを反映するさまざまなメトリックを見つけることができます。

Githubページ

Githubは静的サイトをホストできます。これは、プロジェクトまたはプロモーションWebサイトのWebドキュメントを作成する必要がある場合に非常に便利です。多くは個人ブログにgithubを使用しています。最も単純なケースでは、githubリポジトリ内にindex.htmlでgh-pagesブランチを作成するだけで十分です。ページは次の形式のアドレスで利用できます：http（s）：//.github.io/ <project_name>-たとえば、http://2gis.github.io/makeup/。詳細については、ドキュメントを参照してください。

要点

Gistは、ディレクトリをサポートしないgitリポジトリです。通常、コードとドラフトの断片を保存するために使用されます。そこには、完全なチュートリアルと記事もあります。これは、コメント、バージョン管理、および直接リンクを介してのみ他のユーザーが利用できる無制限の数の秘密レコードを作成する機能を備えた、あらゆる種類のメモに対するgithubの非常に軽いバージョンであると言えます。

Gistは、サードパーティのリソースで使用できます。多くの人がこれを使用して、静的なブログやメディアのコードスニペットの構文を強調しています。ページに埋め込むことができるgistスクリプトコードを取得するには、リポジトリからURLのタイプを選択するメニューから[埋め込み]を選択する必要があります。

ドットファイル

上http://dotfiles.github.io/あなたはすべての好みに合わせて設定Unixベースのシステムの高品質なコレクションを見つけることができます。

オクトデックス

しかし、https： //octodex.github.com/ には、たくさんのオクトコットがあります。これ以上。そこから取ったKDPV。

便利なリンク

Githubには多くの機会がありますが、それらすべてを1つの記事で説明することは大変な作業です。それでも、この資料が新しい知識の優れた情報源となり、Githubをさらに探求するよう刺激されることを願っています。

最後に、この旅に役立つ最も興味深いリソースをいくつか紹介します。

チートシートhttps://github.com/tiimgreen/github-cheat-sheet
素晴らしいGithub https://github.com/Kikobeats/awesome-github
GithubチートシートHabrahabr https://habrahabr.ru/post/219219/
GitおよびGitHub Secrets（Zach Holman）http://confreaks.tv/videos/aloharuby2012-git-and-github-secrets
GitおよびGitHubのその他の秘密（Zach Holman）https://vimeo.com/72955426
https://help.github.com/

— the Steroidtocat by James Kang

githubの効果的な使用

内容