Alternative Architecture DOJO

オルターブースのクラウドネイティブ特化型ブログです。

GitHubリポジトリにポリシーや行動規範を設定する!

こんにちは!
GitHub大好きマーケティング部しんばです。

各GitHubリポジトリで、セキュリティポリシーやCode of Conduct(行動規範)が定義できるって知っていましたか?

GitHubではそれらのポリシー策定し、Issuesの画面からユーザーをポリシーへ誘導させるような機能が存在します!

この記事では、GitHub.comのWebサイト上からセキュリティポリシーや行動規範、コントリビューターガイドラインを設定する方法をお伝えします。

Issueでやり取りする際に誘導リンクが表示される

GitHubリポジトリのIssues

GitHub.comから定義する手順

GitHub.comからポチポチで作成できます。
もちろんgitを使ってコマンドでファイルをコミットしてもOKです!

1. リポジトリのメインページを開く

https://github.com/<User Name/Organization>/<Repository Name>

2. "Add File" → "Create File" を押下し、ファイル名を /.github/○○○○.md とする

○○○○に入る文字列

セキュリティポリシー: SECURITY
Code of Conduct: CODE_OF_CONDUCT
Contributing Guidelines: CONTRIBUTE

3. あとは中身を編集するだけ!

まとめ

Wikiとこれらのポリシーをうまく使い分けてコミュニティや組織で円滑にコントリビューションができるようにしたいですね!

コントリビューションについてはGitHub Docsでも言及されているのでぜひ参考にされてください。

Setting up your project for healthy contributions - GitHub Docs

オルターブースでは開発者体験を強力に後押しするGitHubソリューションを提供しています!

www.alterbooth.com