行動規範ジェネレーター
人気のテンプレートからCODE_OF_CONDUCT.mdファイルを生成。誓約、基準、執行ガイドラインをカスタマイズし、すぐに使えるMarkdownをダウンロードできます。
このツールについて
行動規範ジェネレーターは、人気のテンプレートからCODE_OF_CONDUCT.mdファイルを作成する 無料のブラウザベースツールです。Contributor Covenant 2.1(オープンソースプロジェクトで 最も広く採用されている行動規範)、Citizen行動規範、Django行動規範から選択するか、 完全にカスタムのテンプレートからゼロから作成できます。
ジェネレーターは行動規範のすべてのセクションについてフォームベースのエディターを提供します: 私たちの誓約、私たちの基準(望ましい行動と許容されない行動)、執行責任、 適用範囲、執行手順、4段階の重大度レベル(修正、警告、一時的な禁止、永久的な禁止)を含む 執行ガイドライン。プロジェクト名、連絡先メール、執行委員会名、コミュニティスペースを 入力して、完全でパーソナライズされたドキュメントを生成します。
新しいオープンソースプロジェクトをセットアップする場合は、 リポジトリ用の.gitignoreファイルの生成、 リリースを追跡する変更履歴の作成、 Node.jsプロジェクト用のpackage.jsonのビルドも ご検討ください。
すべての処理はブラウザ内で完全に実行されます。プロジェクト名、メールアドレス、 ドキュメントの内容がサーバーに送信されることはありません。生成されたMarkdownファイルは、 GitHub、GitLab、その他のプラットフォームで認識される標準的なCODE_OF_CONDUCT.md形式に従います。
使い方
- ドロップダウンからテンプレートを選択します:Contributor Covenant 2.1、Citizen行動規範、Django行動規範、またはカスタム。
- プロジェクト名と執行報告用の連絡先メールを入力します。
- 必要に応じて執行委員会名と行動規範が適用されるコミュニティスペースを指定します。
- 展開可能なセクションをクリックして、私たちの誓約、私たちの基準、執行責任、適用範囲、執行、執行ガイドラインをカスタマイズします。
- 右側の出力パネルで生成されたMarkdownを確認します。Previewを切り替えてレンダリングされたビューを確認します。
- CopyをクリックするかCtrl+Shift+Cを押してMarkdownをクリップボードにコピーします。
- Download .mdをクリックしてCODE_OF_CONDUCT.mdとしてファイルを保存し、リポジトリにコミットする準備ができます。
人気の行動規範の例
よくある質問
どのテンプレートを使うべきですか?
Contributor Covenant 2.1はオープンソースプロジェクトで最も広く採用されている行動規範で、Kubernetes、Rails、Swiftを含む10万以上のコミュニティで使用されています。ほとんどのプロジェクトの出発点としてお勧めです。Citizen行動規範やDjango行動規範は、その表現を好む場合の良い代替案です。すべてをゼロから書きたい場合はカスタムを使用してください。
テンプレートをカスタマイズできますか?
はい。テンプレートを選択した後、すべてのセクションが編集可能です。展開可能なセクション(私たちの誓約、基準、執行など)をクリックしてテキストを変更できます。変更はすぐに生成された出力に反映されます。
CODE_OF_CONDUCT.mdファイルをどこに置くべきですか?
リポジトリのルートに配置してください。GitHubはルート、docs/、または.github/ディレクトリのCODE_OF_CONDUCT.mdを自動的に検出し、リポジトリのサイドバーや新しいissueを開く際にリンクを表示します。
執行ガイドラインのレベルとは何ですか?
4つのレベルがあります:1)修正 — 軽微な初回違反に対し、プライベートな警告;2)警告 — 単一のインシデントまたはパターンに対し、継続的な行動への影響あり;3)一時的な禁止 — 深刻な違反に対し、コミュニティとのやり取りの期間限定禁止;4)永久的な禁止 — 持続的な違反パターンに対し、コミュニティからの永久的な排除。
連絡先メールは必要ですか?
はい。コミュニティメンバーが違反を機密に報告できるように、連絡先メールは不可欠です。conduct@yourproject.orgのような専用メール、信頼できるメンテナーの個人メール、またはチームエイリアスを使用できます。
データは安全ですか?
はい。すべてのテキスト生成はJavaScriptを使用してブラウザ内で完全に実行されます。プロジェクト名、メールアドレス、ドキュメントの内容がサーバーに送信されることはありません。ツール使用中にブラウザの開発者ツールのネットワークタブで確認できます。
オープンソース以外のプロジェクトにも使えますか?
もちろんです。行動規範はオープンソースコミュニティから生まれましたが、社内チーム、カンファレンス、ミートアップ、オンラインコミュニティ、企業プロジェクトにも同様に有用です。コミュニティスペースと執行セクションをコンテキストに合わせて調整してください。
関連ツール
READMEジェネレーター
シンプルなフォームからプロフェッショナルなREADME.mdファイルを生成します。テンプレート選択、バッジ追加、セクション設定、即時ダウンロード。
.gitignore生成
言語、フレームワーク、IDEを選択して.gitignoreファイルを生成。複数テンプレートを即座に結合。
Changelogジェネレーター
Conventional CommitsからCHANGELOG.mdを生成します。タイプ別グループ化、バージョンヘッダー、Keep a Changelog形式でエクスポート。
package.json生成
ビジュアルフォームでpackage.jsonファイルを生成。名前、バージョン、スクリプト、依存関係等を設定。
Gitコミットメッセージジェネレーター
ビジュアルフォームでConventional Commitsメッセージを生成します。type、scope、description、body、破壊的変更を選択。
.gitattributesジェネレーター
改行コードの正規化、バイナリファイルの処理、diff/merge設定用の.gitattributesファイルを生成します。
CONTRIBUTING.mdジェネレーター
オープンソースプロジェクト向けのプロフェッショナルなCONTRIBUTING.mdファイルをテンプレートから生成します。
ライセンス識別ツール
貼り付けたテキストからオープンソースライセンスを識別し、権限と条件を比較、ライセンスファイルを生成します。