標準的なオープンソースCONTRIBUTING.md

一般的なオープンソースプロジェクト向けのバランスの取れたCONTRIBUTING.mdを作成。エンタープライズのオーバーヘッドや過度な形式性なしに、最も一般的なセクションをカバー。

Templates

詳細な説明

標準的なオープンソースコントリビューティングガイド

ほとんどのオープンソースプロジェクトはミニマルとエンタープライズの間に位置します。標準的なガイドは、官僚的なオーバーヘッドなしに一貫した貢献のための十分な構造を提供します。

推奨構造

# Contributing to ProjectName

## 行動規範
CODE_OF_CONDUCT.mdへのリンク。

## 貢献方法
### バグの報告
### 機能の提案
### コードの貢献

## はじめに
### 前提条件
### セットアップ
### テストの実行

## 開発ワークフロー
### ブランチ命名
### コミットメッセージ
### プルリクエスト

## コードスタイル

## ありがとう

トーンを正しくする

標準的なガイドは:

  • 歓迎的 -- 関心を持ってくれた人に感謝する
  • 明確 -- 散文ではなく番号付きステップを使用
  • 実用的 -- 抽象的ではなくコマンドを示す
  • 簡潔 -- 必要なことをカバーし、それ以上は不要

セクションの長さ

セクション 理想的な長さ
イントロダクション 2〜3文
バグレポート 5〜10箇条書き
はじめに 5〜7ステップ
コミットメッセージ 短い段落 + 例
PRプロセス 4〜6番号付きステップ
コードスタイル 3〜5箇条書き

「標準」とは

標準テンプレートには以下が含まれます:

  • 行動規範の参照
  • バグと機能リクエストのガイダンス
  • 基本的なセットアップ手順
  • コミットメッセージ規約(通常Conventional Commits)
  • PRプロセス
  • コードスタイルの参照

以下は含まれません:

  • CLA要件
  • セキュリティ開示プロセス
  • 複数レビュアーゲート
  • RFCプロセス
  • ガバナンス構造

メンテナンス

年に一度、または新しいコントリビューターをオンボーディングする際にレビューします。最近のコントリビューターに何が不明確だったか尋ね、それに応じて更新します。

ユースケース

5〜20人の定期的なコントリビューターを持つ中規模のオープンソースプロジェクトが、すべての標準的な基本をカバーするプロフェッショナルだが過度に正式ではないコントリビューティングガイドを必要としている場合。

試してみる — CONTRIBUTING.md Generator

フルツールを開く