閉じるこの動画はお気に入りから削除されています.あなたやあなたの会社はおそらくGithubを使用しています.私は、このポストであなたのGitHubリポジトリを美化する若干のファイルをハイライトしたいです.

リードミー

今までに、誰もがReadmesに精通していることを願っています.repoファイルのルートにReadMeファイルを置くと、Githubはその内容をREPOのホームページに表示します.
しかし、ここでは知らないかもしれないヒントのカップルです.
READMEは異なる形式であるかもしれません:
ファイル名
フォーマットREADME原文README.txt README.md風味のあるMarkdown README.adocAsciidoctor
HTMLが動作しないことに注意してください.Githubは生のHTMLコードを表示します.
さらに、1つの組織のためのREADMEを設定することができます.まず、組織のような名前のリポジトリを作成する必要があります.次に、/.github/profile/ ディレクトリ.例については、このブログの組織a custom page .
詳細についてはdocumentation .

許可

コードを使用したい人は、どの用語を使うかを教えてください.それは正確にあなたのコードを認可するゴールです.伝統的に、ほとんどのパッケージはLICENSE (or LICENSE.txt ) ファイルをルートで返します.Githubはこの練習を採用しました.
あなたが望む任意のライセンスを選択することができますが、Github UIはオープンソースのための良い助けを提供します.ファイルを追加します.新しいファイル名LICENSE , 新しいボタンがポップアップ表示されます:ライセンステンプレートを選択します.それをクリックすると、GitHubは次の選択肢を提供します.

アパッチライセンス2.0

GNU一般公衆利用許諾契約書v 3 .0

ライセンス

簡単なライセンス

BSD 3節“new”または“改訂”ライセンス

ブーストソフトウェアライセンス1.0

クリエイティブ・コモンズ.0ユニバーサル

エクリプス公共ライセンス2.0

一般公衆利用許諾契約書.0

GNU一般公衆利用許諾契約書v 2 .0

一般公衆利用許諾契約書v 2 .1

Mozillaパブリックライセンス2.0

無免許

あなたはその内容をチェックする1つを選ぶことができます.Githubには、そのパーミッション、制限、および条件が表示されます.

これで、確認して提出することができます.この時点で、3つの選択肢があります.

変更のキャンセルキャンセル

ライセンステンプレートを選択します

コミット新しいファイル.リポジトリに新しく選択したライセンスをコミットします

ライセンスを追加した後、Githubはリポジトリのページの右側に表示します.

詳細についてはdocumentation .

共有者

Githubが自動的に要求をプルする構成コードの所有者を追加します.あなたはそれらを定義しますCODEOWNERS ファイルのフォーマット.gitignore .
Githubがどのように処理するのかを簡単にまとめます.

あなたは設定できますCODEOWNERS 根で、または、で.github サブフォルダ

あなたは枝ごとに異なるファイルを持つことができます

一般的な構成ラインは、パターンと所有者から成ります:

*.txt    @nfrankel

@nfrankel すべてを所有するtxt ファイル

と.gitignore , これを順次適用する.一番下の行はトップのものをオーバーライドします.

         @johndoe
docs     @nfrankel

@johndoe すべてを所有する@nfrankel 所有するdocs フォルダ

複数の所有者を設定できます

         @johndoe @nfrankel

所有者は、個人またはa team . チームを定義するには、チーム名を添えてorgの名前を使います.

         @ajavageek/developers

あなたは自分自身を開いたプル要求を確認することはできません!あなたが構成をテストするプル要求を開くならば、Githubはあなたをスキップします.StackOverflow ).

github無効な設定ラインをスキップします.確認するには、UIを使用できます.

セキュリティ

プロジェクトは人々にセキュリティ問題を報告してもらいたい.しかし、通信チャンネル(s)は、ハッカーが問題を解決することができないか、修理されるか、または固定されることができる前に、問題について学ばないために個人的である必要があります.このため、Githubはカスタムセキュリティファイルを提供します.

READMEファイルと同様に、異なるフォーマットを採用できます.
ファイル名
フォーマットSECURITY原文SECURITY.txt SECURITY.md風味のあるMarkdown README.adocAsciidoctor

コードファイルの所有者ファイルのように、あなたはそれをrepoのルートに置くことができます.github サブフォルダ

セキュリティファイルを設定する最も簡単な方法は、UIを介してです.セキュリティタブに移動し、セットアップのセキュリティポリシーボタンをクリックします.新しいウィンドウの[スタートアップ]ボタンをクリックします.
Githubはデフォルトのマークダウンテンプレートを提供しますが、もちろん、書式と内容を変更することもできます.重要なのは、どのようにセキュリティ脆弱性を報告すべきかをユーザに伝えることです.
新しく作成されたファイルがセキュリティビュービューセキュリティポリシーに表示されます.はい、どうぞsample ASCII形式で.

引用

あなたのプロジェクトが良いなら、他のプロジェクトはたぶんそれを使用します.プロジェクトがアカデミックな作品で引用されるかもしれないので、それがアカデミックな自然そのものであるならば、さらに.引用ファイルは次の質問に答えることができます.

ソフトウェアの名前は何ですか.

私が使用したソフトウェアのバージョンを一意に識別するためにどのラベルを使用しますか?

著者として引用されるべき人々の適切なセットは何ですか?

標準的な引用形式はCitation File Format , Githubによって提案されます:

CITATION.cff files are plain text files with human- and machine-readable citation information for software (and datasets). Code developers can include them in their repositories to let others know how to correctly cite their software.

あなただけでなく、引用符を書式化する方法を選択することができますまた、関連する学術論文などの代替ソースを引用する.
再び、GithubのUIは、1つを作成するのに役立ちますCITATION.cff ファイル.つを作成すると、それはあなたの心のコンテンツに編集することができますサンプルを追加することを提供します.

cff-version: 1.2.0
title: Beautify GitHub sample repository
message: If you really want to cite this repository, here's how you should cite it.
type: software
authors:
  - given-names: Nicolas
    family-names: Fränkel
repository-code: 'https://github.com/ajavageek/beautifygithub'
license: Unlicense

ファイルを追加した後、このサイドバーに新しいリポジトリリンクが表示されます.コピーする形式、apaまたはbibtexをクリックすると、どの形式を選ぶことができます.

後援

最後に、少なくとも、スポンサーの設定方法を見てみましょう.あなたがオープンソースプロジェクトを通して第三者に価値を提供するならば、彼らにあなたに報酬を与えることは、意味があります.しかし、あなたはそれを数えるべきではないことに注意してください、またはあなたは驚きのためです.
Githubは、専用の経由でスポンサーオプションを表示することができますFUNDING.yml に.github リポジトリ.もう一度、UIが役立ちます.ボタンをクリックして設定してください.通常のウィンドウを開き、新しいファイルをテンプレートで作成します.以下に変更点を示します.

github:
  - nfrankel
custom:
  - https://paypal.me/nicofrankel

タブで入力を確認します.

この場合、検証は失敗しますnfrankel 私はGithubスポンサープログラムに登録しませんでした.
新しい「スポンサーこのプロジェクト」セクションは、レポのホームページの右側サイドバーに現れます.
あなたはそれを表示するための設定で“後援”チェックボックスをチェックする必要があります.したがって、レポですべてを準備することができますし、準備ができているときにのみアクティブにします.

結論

GitTubは、リポジトリのディスプレイとユーザビリティを向上させるために複数の方法を提供しています.ライセンスとReadMeは、他のユーザーと共有するリポジトリに必須である必要があります.それらの他に、あなたはこのポストにリストされる他の美学を提供しなければなりません.
この投稿の完全なソースコードはGithubにあります.

アヤアベーク / ビューティフルジョッキ

Githubリポジトリを美しくする方法

あなたのgithubレポを美化してください

アスキードクター形式再び!
View on GitHub
さらに進む

Customizing your repository

Adding a security policy to your repository

Citation File Format (CFF)

About CITATION files

GitHub special files and paths

当初公開A Java Geek 2022年4月17日