vital.vim icon indicating copy to clipboard operation
vital.vim copied to clipboard

CONTRIBUTING.md 作る

Open thinca opened this issue 10 years ago • 14 comments

CONTRIBUTING.md を作って、コミットメッセージやその他もろもろの決まりをまとめる。 参考: https://github.com/blog/1184-contributing-guidelines

thinca avatar Jun 15 '14 06:06 thinca

:+1:

mattn avatar Jun 16 '14 01:06 mattn

:+1:

On Mon, Jun 16, 2014 at 10:10 AM, mattn [email protected] wrote:

[image: :+1:]

— Reply to this email directly or view it on GitHub https://github.com/vim-jp/vital.vim/issues/172#issuecomment-46133816.

tyru avatar Jun 16 '14 14:06 tyru

:+1:

rhysd avatar Jun 16 '14 14:06 rhysd

#468 で thinca さんが

わかりやすい場所に文書化されていないので知らなくて当然なんですが(大変申し訳ない 🙇 )、互換性のない変更が入る場合は Changes ファイルにその内容を記述することになっています。

と言ってたのでちょっと考えました。

  • Changes に記載の必要はあるか
  • doc のみの修正か、コードと doc の修正か
    • 後者なら doc がちゃんと更新されているか(必要無しなら「必要無し」と記載)

CONTRIBUTING.md というか、.github/PULL_REQUEST_TEMPLATE.md の役目のような気もしますが… (というか両者の使い分けが分かってなくて、.github/PULL_REQUEST_TEMPLATE.md が CONTRIBUTING.md の上位互換な気がしてしまう)

あと、このページが CONTRIBUTING.md(もしくは PULL_REQUEST_TEMPLATE.md)にそのまま持ってこれる気がします。

参考リンク

tyru avatar Jan 15 '17 04:01 tyru

@tyru PULL_REQUEST_TEMPLATE.mdは、チェックリスト的な使い方をする場合が多いようです(homebrew-coreなど)。

umireon avatar Jan 15 '17 06:01 umireon

なるほど、ありがとうございます。

tyru avatar Jan 15 '17 07:01 tyru

昨日(というか今日) @haya14busa さんと話していたのですが,言語についても日本語・英語両方 OK で英語も welcome だよというのを CONTRIBUTING.md に明記したいと思いました(日本語圏外から見ると英語と日本語入り乱れたりしていてよく分からなさそう…)

ref: https://twitter.com/Linda_pp/status/820349546446209028

rhysd avatar Jan 15 '17 07:01 rhysd

純粋な疑問なのですが、このプロジェクトは、全ての貢献の全てのコードに対して、NYSLの要件を満足するために、著作権の放棄および著作人格権の不行使を要求しますか?

umireon avatar Jan 15 '17 07:01 umireon

他の多くのプロジェクト同様,明示的にそういったことは行っていません(大きいプロジェクトだと CLA に署名させたりしてるようですが).なので,厳密にはプルリクエストで入った変更はプルリクエストの author に著作権があることになると思いますが,そこは性善説でそのままになっていると思います(飽くまで僕個人の見解ですが)

rhysd avatar Jan 15 '17 07:01 rhysd

@rhysd 性善説を採れることが最も重要ですが、ライセンスが不明瞭である(NYSLになってないかもしれない)というのは問題だと思います。 The unlicenseで説明されているような、貢献者に著作権の放棄を求めるような文言を、CONTRIBUTING.mdに記載しておくのが安全かと思います。 このプロジェクトでCLAを使うことはやりすぎである、ということには全面的に同意します。

また、NYSLは、日本国内では確実に通用しますが、もしかしたらパブリックドメインとしての機能を果たさない国があるかもしれません。 CC0は、確実に全世界でパブリックドメインまたは同等に自由なライセンスを保証します。

umireon avatar Jan 15 '17 08:01 umireon

はい,そのような文言は入れておいたほうが良いと僕も思います.PR が出た際にはレビューしてもらえると助かります.

rhysd avatar Jan 15 '17 09:01 rhysd

#468 で @umireon さんが冒頭の文章をチェックリスト形式で書いてくれたので、これを PULL_REQUEST_TEMPLATE.md などに適用できるかもしれません。

tyru avatar Jan 15 '17 10:01 tyru

また、NYSLは、日本国内では確実に通用しますが、もしかしたらパブリックドメインとしての機能を果たさない国があるかもしれません。 CC0は、確実に全世界でパブリックドメインまたは同等に自由なライセンスを保証します。

もしかしたら CC0 と NYSL のデュアルライセンスにした方がいいかもしれないですね(CC0 が NYSL を包含するなら CC0 一択でも良さそう)。 #26 の通り、「できるだけ緩く」ぐらいの感覚で NYSL に決めたので…

tyru avatar Jan 15 '17 10:01 tyru

すみません、すでに #472 で issue 建ててくれてましたねw

tyru avatar Jan 15 '17 10:01 tyru