hrsano645 / vs-covid19

#民間支援情報ナビ 静岡版です
https://vs-covid19-shizuoka.netlify.com/
Apache License 2.0
7 stars 4 forks source link

CONTRIBUTING.mdの追加 #22

Closed hrsano645 closed 4 years ago

hrsano645 commented 4 years ago

コントリビュートの方針を追加します。

Okochama commented 4 years ago

プルリクの段取り、たたき台です。

  1. githubでissueを立てる。Slackで共有。(Slackでの会話がきっかけで→issue化のパターンもあり)
  2. issueでソースに手を入れ始める場合はAssignessで立候補表明。
  3. hrsano645/vs-covid19:dev-shizuoka-custom から自分のリポジトリへpullして最新にする
  4. 自分のリポジトリのdev-shizuoka-customでissueに関する機能追加ブランチを作成。名前はissue-対象番号とか
  5. 機能追加ブランチで変更作業
  6. 機能追加ブランチからhrsano645/vs-covid19:dev-shizuoka-customへプルリクを出す。

参考 https://github.com/tokyo-metropolitan-gov/covid19#ブランチルール

hrsano645 commented 4 years ago

ありがとうございます!そのまま作りましょうかね。

Okochama commented 4 years ago

じゃ私が #24 の修正について、上の2.以降の流れに沿ってやってみます。 その結果微調整した結果を、私がCONTRIBUTING.mdにまとめてみるって段取りでどうですか?

hrsano645 commented 4 years ago

お願いします。今週ちょっとやっている余裕がなかったので😅

hrsano645 commented 4 years ago

@Okochama slackで進めていた、devブランチをやめて、本番+機能追加ブランチのみの運用に書き換えてみました。

参考


  1. githubでissueを立てる。Slackで共有。(Slackでの会話がきっかけで→issue化のパターンもあり)
  2. issueでソースに手を入れ始める場合はAssignessで立候補表明。
  3. hrsano645/vs-covid19:foo-shizuoka-custom から自分のリポジトリへpullして最新にする
  4. 自分のリポジトリのfor-shizuoka-customでissueに関する機能追加ブランチを作成。名前はissue-対象番号とか
  5. 機能追加ブランチで変更作業
  6. 機能追加ブランチからhrsano645/vs-covid19:for-shizuoka-customへプルリクを出す。

netlifyのプルリクエストデプロイ機能で、プルリクエストの内容で一時的にデプロイ結果を見ること(デプロイプレビュー)ができます。ローカルでチェックする以外の方法として利用できます。

Introducing Deploy Previews in Netlify | Netlify


hrsano645 commented 4 years ago

それと、Slackでも何度か質問が来ている、情報提供の手段もこちらにまとめます。

貢献者リストはREADME.mdのほうがよさそう?

Okochama commented 4 years ago

貢献者リストは東京の対策サイトだと、「CONTRIBUTORS.md」ってファイルで貢献者リスト作っているようですね。 https://github.com/tokyo-metropolitan-gov/covid19/blob/development/CONTRIBUTORS.md

表の様式はちょっとslackでも意見を聞いて、同じように別ファイルにしてREADME.mdやindex.htmlのフッターからリンクさせるでどうですかね

Okochama commented 4 years ago

こんな感じでどうでしょう。


貢献の仕方

このサイトは静岡県内のNPO、シビックテック団体、他個人の有志にて開発・運営しています。


支援情報を投稿するには

下記の情報収集フォームより情報をお寄せ下さい。
https://forms.gle/ZXUhKnHA1pZiLnva8

投稿頂いた内容は運営メンバーで確認の上、公開用のシートに記入いたします。


開発に参加するには

修正の流れ

  1. githubでissueを立てる。すでにissueができている場合は2.に進んで下さい。
  2. issueに対して自分が修正する場合は、issueのコメントで立候補して、Assigneesに自分を設定して下さい。
  3. hrsano645/vs-covid19:for-shizuoka-custom の内容を自分のリポジトリへpullやmergeして最新にして下さい。
  4. 自分のリポジトリのfor-shizuoka-customからissueに関する機能追加・修正ブランチを作成して下さい。
    ブランチ名はPRを受けた際に分かりやすいように、issue-番号 のように命名する番号はissue番号として下さい。
  5. 自分の機能追加・修正ブランチで修正作業して下さい。
  6. 機能追加・修正ブランチから、hrsano645/vs-covid19:for-shizuoka-customへPull Requestを発行して下さい。
hrsano645 commented 4 years ago

@Okochama LGTMです!

hrsano645 commented 4 years ago

貢献者リストは東京の対策サイトだと、「CONTRIBUTORS.md」ってファイルで貢献者リスト作っているようですね。 https://github.com/tokyo-metropolitan-gov/covid19/blob/development/CONTRIBUTORS.md

表の様式はちょっとslackでも意見を聞いて、同じように別ファイルにしてREADME.mdやindex.htmlのフッターからリンクさせるでどうですかね

そうですね。自分から聞いてみます。 自分としてはCfJのように個人名と団体名は一緒のほうが外側にも見てもらえるので良いと思ってます。 両者を乗せるのは希望すればでよいと思うので、個人名@Code for *** といった感じかな。

貢献者リストは別のissueにしておきますね。

hrsano645 commented 4 years ago

32 でマージしたのでこちらはクローズします