CONTRIBUTING.mdジェネレーター
オープンソースプロジェクトのためのコントリビューティングガイドラインを生成。テンプレートを選択し、セクションを設定して、CONTRIBUTING.mdを即座にダウンロード。
このツールについて
CONTRIBUTING.mdジェネレーターは、オープンソースのメンテナーがプロジェクトの 包括的なコントリビューティングガイドラインを作成するための無料のブラウザベースツールです。 ゼロからコントリビューションガイドを書く代わりに、ビジュアルフォームに入力して、 リポジトリ用の構造化されたMarkdownドキュメントを取得できます。
ジェネレーターは4つのテンプレートをサポートしています：基本的なガイダンスのみが必要な 小規模プロジェクト向けのMinimal、コード貢献のある一般的なオープンソースプロジェクト向けの Standard、コード、ドキュメント、翻訳、テスト貢献を受け入れる大規模プロジェクト向けの Comprehensive、CLA要件、セキュリティポリシー、正式なレビュープロセスを持つ 企業支援プロジェクト向けのEnterpriseです。
設定可能な主要セクションには、コミュニケーションチャネル（Discord、Slack、GitHub Discussions）、 開始手順（前提条件、fork/clone、install、run）、貢献タイプ（バグレポート、機能リクエスト、 コード、ドキュメント、翻訳、テスト）、ブランチ命名規則、コミットメッセージフォーマット （Conventional Commits、Angular、Gitmoji）、プルリクエストプロセス、コードスタイル要件が含まれます。
その他のプロジェクトドキュメントが必要な場合は、CHANGELOG.mdファイルの Changelogジェネレーター、ignoreファイルの .gitignoreジェネレーター、またはMarkdownを リアルタイムで編集・プレビューするMarkdownプレビューを お試しください。
すべての処理はブラウザ内で完全に実行されます。プロジェクトの詳細、名前、 設定データがサーバーに送信されることはありません。
使い方
- ドロップダウンからテンプレートを選択して、事前設定されたセクションセットで開始します（Minimal、Standard、Comprehensive、Enterprise）。
- プロジェクト情報セクションにプロジェクト名とオプションの行動規範リンクを入力します。
- Discord、Slack、GitHub Discussionsのリンクを追加してコミュニケーションチャネルを設定します。
- 前提条件、インストールコマンド、実行コマンドで開始手順を設定します。
- バグレポート、機能リクエスト、コード、ドキュメント、翻訳、テストのセクションを含めるために貢献タイプを切り替えます。
- コミットメッセージフォーマットを選択します（Conventional Commits、Angular、Gitmoji、なし）。
- ライブプレビューパネルを確認し、CopyをクリックするかCtrl+Shift+Cを押してコピー、またはDownloadでCONTRIBUTING.mdとして保存します。
CONTRIBUTING.md の人気例
よくある質問
CONTRIBUTING.mdファイルとは何ですか？
CONTRIBUTING.mdファイルは、オープンソースリポジトリのルートに配置されるドキュメントで、他の人がプロジェクトにどのように貢献できるかを説明します。通常、バグの報告方法、機能の提案、コード変更の提出、コーディング標準の遵守、コミュニティへの参加について説明します。GitHubはこのファイルを認識し、ユーザーが新しいissueやプルリクエストを開く際にリンクを表示します。
どのテンプレートを選ぶべきですか？
小規模な個人プロジェクトにはMinimalで十分です。ほとんどのオープンソースプロジェクトにはStandardが良いバランスを提供します。多くの種類の貢献を受け入れる人気プロジェクトにはComprehensiveを使用します。Enterpriseは、CLA署名、セキュリティスキャン、複数レビュアー要件など、正式なプロセスが必要な企業支援プロジェクトに最適です。
生成された出力をカスタマイズできますか？
はい。ツールは標準的なMarkdownを生成するので、コピーまたはダウンロード後に編集できます。生成前にフォームを通じてすべてのセクションを調整することもできます。Markdown出力はGitHub、GitLab、およびすべてのMarkdownレンダラーで正しく表示される標準構文を使用しています。
Conventional Commitsフォーマットとは何ですか？
Conventional Commitsは、構造化されたフォーマットを使用するコミットメッセージの仕様です：type(scope): description。typeは変更の種類（feat、fix、docsなど）を示し、オプションのscopeは影響範囲を絞り込み、descriptionは変更を要約します。このフォーマットにより、自動的なchangelog生成やセマンティックバージョニングが可能になります。
行動規範を含めるべきですか？
はい、コミュニティからの貢献を歓迎するオープンソースプロジェクトには行動規範をお勧めします。行動に対する期待を設定し、歓迎的な環境の構築に役立ちます。既存の行動規範ファイル（CODE_OF_CONDUCT.mdなど）にリンクするか、Contributor Covenantなどの標準を参照できます。
データは安全ですか？
はい。すべての処理はJavaScriptを使用してブラウザ内で完全に実行されます。プロジェクト名、設定、生成されたコンテンツがサーバーに送信されることはありません。ツール使用中にブラウザの開発者ツールのネットワークタブで確認できます。
JavaScript以外のプロジェクトのガイドも生成できますか？
もちろんです。デフォルトの開始手順コマンドはnpmの例を使用していますが、すべてのコマンドをプロジェクトの技術スタックに合わせて変更できます（pip install、cargo build、go buildなど）。貢献タイプ、コミットフォーマット、PRプロセスは言語に依存しません。
関連ツール
READMEジェネレーター
シンプルなフォームからプロフェッショナルなREADME.mdファイルを生成します。テンプレート選択、バッジ追加、セクション設定、即時ダウンロード。
行動規範ジェネレーター
Contributor Covenant、Citizen、Django、カスタムテンプレートからCODE_OF_CONDUCT.mdファイルを生成します。
Changelogジェネレーター
Conventional CommitsからCHANGELOG.mdを生成します。タイプ別グループ化、バージョンヘッダー、Keep a Changelog形式でエクスポート。
Conventional Commitsリンター
コミットメッセージをConventional Commits仕様に照らして検証します。type、scope、description、bodyのフォーマットをチェック。
.gitignore生成
言語、フレームワーク、IDEを選択して.gitignoreファイルを生成。複数テンプレートを即座に結合。
Issueテンプレートビルダー
GitHubおよびGitLabのIssueテンプレートをビジュアルに構築します。YAMLフォームまたはMarkdownテンプレートを生成。
PRテンプレートビルダー
GitHubおよびGitLab向けのカスタマイズ可能なプルリクエストテンプレートをMarkdown形式で生成します。
ライセンス識別ツール
貼り付けたテキストからオープンソースライセンスを識別し、権限と条件を比較、ライセンスファイルを生成します。