【1.0.0 ドックフーディング】不明点・修正点まとめ

[pss-aileen]

Discordの件の、不明点・修正検討の部分はこちらで！

• バージョン1のリリースに含めるものは基本ドキュメント関連
• コード、サイトの裏側は1.0.0以降で

---

確認用トピックリスト

（以下のコメントのトピックをリストにして、それぞれissue化して紐付けたい。
ほぼ確定したことと、議論が必要な問題の整理と、イシュー化を忘れないために。）

例）

• Step4:
  • 確定）,が不要なので修正する→ #イシューナンバー
  • 確定）カラーコード、絵文字を参照できるサイトのリンクを記載する

[pss-aileen]

Step 7:プルリクエスト（PR）を作成 でどこのブランチに向けてマージするか

• マージする際ってmainに確か向かった気がする
• 一応 main に向けてマージと書いておいたほうがよさそう

[kagomen]

https://github.com/ユーザーネーム/first-contributions-ja

↓

https://github.com/first-contributions-ja/first-contributions-ja.github.io

ですかね？
https://github.com/kagomen/first-contributions-ja.github.ioに飛んだらプルリクできない謎のページ？に行き着きました

[pss-aileen]

ここの場面ですね、大丈夫かと思いますが、mainに向かっていることを確認するようにしてもよいのかなと

[pss-aileen]

#150 (comment)

[kazzyfrog]

Step2:

順番を変更した方がいいかも
現在

• ターミナルを開き、リポジトリをクローンするディレクトリに移動します。
• GitHub 上の、フォークしたリポジトリのページに移動し、緑色の "Code" ボタンからクローンする URL をコピーします。
• 以下のコマンドを使用して、フォークしたリポジトリをローカルマシンにクローンします：
  ↓
• GitHub 上の、フォークしたリポジトリのページに移動し、緑色の "Code" ボタンからクローンする URL をコピーします。
• ターミナルを開き、リポジトリをクローンするディレクトリに移動します。
• 以下のコマンドを使用して、フォークしたリポジトリをローカルマシンにクローンします：

[kazzyfrog]

STEP3

• 次のコマンドでリポジトリのディレクトリ内に移動します：cd first-contributions-ja
  これはミス
  正しくは、
• 次のコマンドでリポジトリのディレクトリ内に移動します：cd first-contributions-ja.github.io

[pss-aileen]

こちらは修正確定かと思います

[kazzyfrog]

Step4

"favoriteEmoji": "あなたの好きな絵文字",
これの末尾のカンマ,が不要。

[kazzyfrog]

あなたの好きなカラーコード
に関しては、カラーコードを見れるツールのリンク貼った方が丁寧かも！

[kagomen]

• やっぱり絵文字3つくらい登録したい！
• ↑のカラーコードと同じように、絵文字に関しても絵文字リストを載せてもいいかも
• 変更を保存するのを忘れないで！みたいな文言ほしいかも

[pss-aileen]

• , 不要同意
• カラーコード 同意 日本カラー良き
  • https://www.colordic.org/y
  • https://nipponcolors.com/ ⭐️
  • https://yeun.github.io/open-color/
  • https://colorhunt.co/palettes/pastel
• 絵文字リストも同意！

[kazzyfrog]

その他思ったこと：

やっぱりJSONファイルの整形は必須かも。
コードを貼り付けて、インデントなどが揃っていないと、少し戸惑う。。

所感：
なんか、わかりにくい・迷ってしまう、、などと感じる部分は多々ありそう！と思ったが、
いかんせん自分で作ったから、違和感なくすんなり出来てしまった。
もっとフィードバックが欲しいところです！

[pss-aileen]

まだドックフーディングしてませんが
逆にインデント自分でしてもらう、調整してもらうというのもありかもしれません！

コーディングのルールに従おう的な感じで

[pss-aileen]

マージ時のメッセージ

プルリクエスト確認しました！
LGTM✨

以上でコントリビューションは終了です！

参加してくれてありがとうございました！
よろしければ参加のご感想をお聞かせください！

的なテンプレでもよいので
あると「これでちゃんとマージされたんだな！」やった！と思えそそう。

[kagomen]

こちら、あった方が絶対良いなと思いました！✨
また、

よろしければ参加のご感想をDiscussionでお聞かせください！

のようにリンクを貼ったらよりスムーズだと思いました！

[kagomen]

STEP前

このプロジェクトの目的は？

• しずらい→しづらい

どんな貢献をすればいいの？

• 貢献の方法はわかるけど、どういう結果になるのかがわからない（これは個別ページを用意してないからしょうがないですよね）
• 最後に「それでは詳しく説明していきます！実際に手を動かしてみてみましょう！」的な文言があると流れが自然だなと思った

[pss-aileen]

貢献の方法はわかるけど、どういう結果になるのかがわからない

• 「TOPページの人数変わるよ！」的な、個人の情報の入力は今後のアップデートでページやカードが表示できるようになる...と書いておくか...！
• イメージがあると良いですよね

[kagomen]

STEP 1

フォークしたものの、自分が何をしたのかがよくわからなかった

• STEP2以降の作業とどう繋がってるのかがよくわからない（その解説までする必要はない気もするが・・・）

[kagomen]

STEP 5

エディタからターミナルに作業場が移動してるので、「ターミナルに移動し、」みたいな文言があるとよりわかりやすいと思った

[kagomen]

Finish

「それ」→「あなたの変更内容は」（個人的にちょっと気になった）

[kagomen]

さらなるステップ

もし興味があれば、その他の貢献を確認してください。
または、Discussionsにて、このプロジェクトに関する感想を聞かせてください 🙌

• 順番逆でも良いかも？よりイージーなものを前にした方が良い気が？（感想書いてほしいですし！）

• 引用になってるところを、CONTRIBUTING.mdのようにAlert で書いた方が良い気がした

完全日本語のチュートリアルで、OSS 活動を始める 🚀

READMEの一番最初のここも！

[pss-aileen]

はじめに

• オープンソースがそもそもわからない人への一言解説があっても良いかと思った
• コラボレーションってなんだろうとやはり思う
• 概念の説明が欲しい

[pss-aileen]

参加方法

• 「どんな貢献をするか」ではなく、「何をするのか？」
  • 貢献だと、なんだか飲み込めない
• 記載する情報は以下の通り、のコードは {} があったほうが、現実のものに近いと思った

どんな貢献をすればいいの？

このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールを作成します！
引用にするとちょっと存在感がうすくなってここわりと大切だけどスルーしちゃいそう

「今回の貢献はプロジェクトの参加者として、Contributors（貢献者一覧）ファイルにあなたの情報を入力しこのリポジトリにアップロード(？）します。」

[pss-aileen]

実際に手を動かす

• 8 つの簡単なステップで、オープンソースのコントリビューターになる 😎
  • これは引用ではなく、太字でもいいかも。

[pss-aileen]

他、まだありますが明日アップします。

[pss-aileen]

Step1

どこまで親切にするかですが、こういう画面がでるよ〜と、
Copy the main branch onlyはチェックのままでOKだよ〜まで書くと親切かと思った

[pss-aileen]

Step2

• フォークとクローンの概念が欲しいなぁ〜と思った、日本語リポとして少し噛み砕ければなと
• フォーク リポジトリをフォークする - GitHub Docs

  • フォークは、上流リポジトリに再提案する前に、アイデアや変更に繰り返し取り組むために使用されます。たとえば、オープンソース プロジェクトや、ユーザーが上流リポジトリへの書き込みアクセス権を持っていない場合などです。

• クローン リポジトリをクローンする - GitHub Docs
  • 全く同じもの、コピー

  • マージの競合の修正、ファイルの追加や削除、より大きなコミットのプッシュを簡単に行うことができます。

---

緑色の "Code" ボタンからクローンする URL をコピーします。

修正提案）緑色の "Code" ボタンをクリックし、HTTPS の URL ををコピーする。

[pss-aileen]

そう、そもそもOSSコントリビュートはフォークするなんて知らなかった。
クローンしてそのまま参加できるものだと思っていた
権限周りのこと知らなかった、

[pss-aileen]

Step3

• クローンした後、フォルダに移動してからはVSCodeのターミナルで実行するのはどうか？
• クローンして、フォルダができあるまでと、ブランチをわけてからの作業はわけたほうが作業の分離？というか、わかりやすい気がする

なので、個人的にやるとしたら

cd first-contributions-ja

として、

code .

と入力して、コードエディタを開きます。...
と、思ったのですが code . はVSCodeでフォルダを開くコマンドだったので保留

ただ、この段階でエディタを開く方がよいかな〜と
それか、エディタをあえて絞って作ってやってみるか

あ、あと、好きなコードエディタである場合だったとしても
最初に使うものはお好きなエディタとターミナル！とどこかで書いておくと良いかも。

---

修正提案1

現状

次のコマンドでリポジトリのディレクトリ内に移動します：cd first-contributions-ja

改善案

コピーできるようにコードブロックにする

• 次のコマンドでリポジトリのディレクトリ内に移動します

  cd first-contributions-ja

修正提案2

現状

• プロジェクトのmainブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
  • 以下のコマンドを使用できます：

  git switch -c <ブランチ名>
  

• ブランチ名は、あなたがこれから行う作業に関連した意味のある名前を付けます。
  • 例えば以下のようになります（yournameをあなたのハンドルネームに置き換えることを忘れないでください）：

  git switch -c add-yourname
  

改善案

• プロジェクトのmainブランチから、あなたの作業を切り離すため、新ブランチを作成します。
• yourname には、あなたのハンドルネームに置き換えてください
• ひらがな、漢字、半角空白は使わず、半角英数字で入力してください
• ❌: おぎのちひろ、荻野ちひろ、Ogino Chihiro

git switch -c add-yourname

例）

git switch -c add-oginochihiro

[pss-aileen]

Step4

Step3かStep4で

git status

を使って、きちんと新しいブランチにいるか確認できるようにすると良いかも

[pss-aileen]

全体

yourname とされているところは、例として全部 oginochihiro 入れておいたら実際の入力のイメージわくかも
よくあるが「yourname」と書かれていてそこに入れるにも実際どういれたらいいのかの例を見たいと思うことがあるので...

[pss-aileen]

Step7

プルリクエスト作成時に、どのリポジトリのどのブランチから、first-contributions-jsのmainに向かっているかを確認してもらいたい
一応。間違いないように。

あと、タイトル、概要欄はどうすればいいのか。
タイトルはそのまま、概要は空欄で良いのかなど

[pss-aileen]

あと、最終的にTOPに人数が表示されるけど、そこが変わっているかは確認させなくて良いか？
現状そこが連動しているので....
npm run devで...！

[pss-aileen]

ざっと以上かな、と思います！