スポンサーリンク

GitHub の CONTRIBUTING には何を書けばいいのか?

スポンサーリンク
GitHub の CONTRIBUTING には何を書けばいいのか? Git
スポンサーリンク

スポンサーリンク

はじめに

GitHubのOSSプロジェクトを見ているとリポジトリのルート直下に存在する CONTRIBUTING.md というファイルをよく目にします。
これは、OSSに対してコントリビュートする際に目を通すべきことが書かれているものです。

具体的にどんなことを書けば良いのかを調べてみました。

サンプル

それはサンプルをいくつか見ていきます。

js-primer

asciidwango/js-primer
:book: JavaScriptの入門書 - JavaScript Primer. Contribute to asciidwango/js-primer development by creating an account on GitHub.

(JS)ECMA2015以降の文法を体系的に学べるドキュメントのリポジトリの CONTRIBUTING です。

大項目を見ていくと…

  • Issuesについて
  • プルリクエストの方法
  • 開発方法 (開発サーバの起動方法)
  • テスト方法
  • コミットメッセージの規約
  • 書式・ディレクトリ構造・ルール

こんな内容が書かれています。

README にも被る内容が書かれていますが、
CONTRIBUTING は、コマンドやソースコードレベルのより具体的な内容に触れています。

参考

Contributing Guidelines - The GitHub Blog
Oftentimes open source projects place a CONTRIBUTING file in the root directory. It explains how a participant should do things like format code, test fixes, an...
Git
スポンサーリンク
スポンサーリンク
スポンサーリンク
404 Motivation Not Found
タイトルとURLをコピーしました