前回から引き続きgithub関係について備忘録としてまとめておきたいと思います。
今回は検索時に表示される説明文(ディスクリプション)を用意する方法です。
■githubをpublicで公開した時に気づいたこと
ここ最近、publicで上げたコードが検索に引っかかることがあるのですが、
説明文(ディスクリプション)がデフォルトのままなんですよね。
ディスクリプションとは、googleなどで検索した際に表示される説明文のことです。
自分の場合、公開したコードが検索に引っかかると
こんな感じになってしまいます。
Contribute to Elsammit/Moguratataki development by creating an account on GitHub.
これじゃ何が何だか分からないですよね。。。
ということで、
今回はこちらの説明文を変更するための方法を調べてみましたのでまとめていきたいと思います。
■ディスクリプションを用意する方法
github上でそれらしい内容が見当たらない。。
ということで、他の方のgithubを参考にすることに！！
githubには多くの方がコードを公開しているので、
「github machine learning python」
などと検索すればすぐにgithubで公開されているコードがヒットします。
ヒットした方々のは記載したであろうコメントが掲載。
何が表示されているのだろうと除いたところ、、
Aboutの内容が表示されている様子！！
Aboutはこちらのようにgithubの右上に表示される説明文のこと。
Aboutはgithub内での説明文として用いられるものだと思っていましたが、
ディスクリプションにも用いられているのですね。
stack overflowにも同じような疑問を持っている方がいらっしゃって、
Aboutを編集すればOKって回答になっていますね。
How do you change a repository description on GitHub? - Stack Overflow
さらに色々調べていくと、、
こちらの方のようにAboutにリンクを貼っておくとリンク内の内容がディスクリプションに表示するもよう。
github.com
■試しに対応
ということで、自分もAboutに記載してみることに。
記載した結果はこんな感じ。
github.com
実際に検索にヒットした時の表記への反映には時間がかかるかと思いますので、しばらく待ちです。
