Skip to content

READMEの チュートリアルの文章の修正 #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Apr 5, 2024
Merged

READMEの チュートリアルの文章の修正 #166

merged 4 commits into from
Apr 5, 2024

Conversation

@kazzyfrog
Copy link
Member

@kazzyfrog kazzyfrog commented Apr 3, 2024 •
edited
Loading

概要

ドッグフーディングを行なって、見つかった修正点について、
README.mdファイルを更新しました！

関連するIssue

closed #165
イシューに、修正点まとめてあります！

その他

引用で書いていた箇所は、
太字でも、あまり強調されている感はないかも？です！

ここから確認したほうが、分かりやすいかもです！

@kazzyfrog
Copy link
Member Author

ざっくり修正が確定したことを中心に更新したので、
１度確認しつつ、再度気になる点があれば、更新していければと思います！！

@kazzyfrog
Copy link
Member Author

思ったのは、Step8の「レビューとフィードバックに対応」で、
待つ時間があるので、そこにも以下のように書いてもいいかも

もしこのプロジェクトが役に立つと思った場合は、ページの上部から ⭐star ボタンを押してください！

@kazzyfrog kazzyfrog added the Type: 📚 docs ドキュメント作成、追記に関するもの label Apr 3, 2024
pss-aileen
pss-aileen reviewed Apr 4, 2024
View reviewed changes
Copy link
Collaborator

@pss-aileen pss-aileen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

お疲れ様です！修正ありがとうございます🙇‍♀️

引用で書いていた箇所は、
太字でも、あまり強調されている感はないかも？です！

こちらに関してコメントしているのでご確認よろしくお願いいたします🙇‍♀️

@kazzyfrog
Copy link
Member Author

kazzyfrog commented Apr 4, 2024 •
edited
Loading

あと、必要であればですが、
フォーク、クローン、ブランチ、コミット、、などの概念の説明ですが、
最初のセットアップに、ドロップダウン？でまとめて、単語の説明一覧を追加するとかはどうでしょう？

@kazzyfrog kazzyfrog marked this pull request as ready for review April 4, 2024 10:03
@kagomen
Copy link
Member

kagomen commented Apr 5, 2024 •
edited
Loading

@kazzyfrog

修正ありがとうございます！🙏
昨日は時間がとれず、反応が遅くなってしまい、すみません！

一点、レビューというか質問なのですが、引用って文の強調（？）にも使用するものなのでしょうか？
個人的にはわりと不思議だなと思うのですが……👀

READMEでいうと、以下の箇所です。

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

このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールを作成します！

8 つの簡単なステップで、オープンソースのコントリビューターになる 😎

@kagomen
Copy link
Member

kagomen commented Apr 5, 2024 •
edited
Loading

@kazzyfrog

必要であればですが、
フォーク、クローン、ブランチ、コミット、、などの概念の説明ですが、
最初のセットアップに、ドロップダウン？でまとめて、単語の説明一覧を追加するとかはどうでしょう？

その情報が必要な人にとっては、行ったり来たりのスクロール？になりそうなので、まとめて説明されているよりも、各ステップにアコーディオンで説明がある方が優しいかな？という気がしますが、どうなんでしょう……。
まとまってる方が良い、という人もいそうな気も……？

@kazzyfrog
Copy link
Member Author

@kagomen

反応が遅くなってしまい、すみません！

全然大丈夫です！コメントありがとうございます！！

一点、レビューというか質問なのですが、引用って文の強調（？）にも使用するものなのでしょうか？
個人的にはわりと不思議だなと思うのですが……👀

確かに違和感あるかもですが、
文の強調というか、コピーなどを表記するのに使われることは、時々？あります！
（少なくとも、自分独自の書き方ではないということです！）

@kazzyfrog
Copy link
Member Author

kazzyfrog commented Apr 5, 2024 •
edited
Loading

各STEPの「これにより〜」という要約的な文章を、
以下のように強調して書く形で、一旦いいかもしれないと思いました！！😎

Note

これにより、あなたの GitHub アカウントに、このリポジトリのコピーが作成されます 👍

Tip

これにより、リポジトリがあなたのローカルマシンにコピーされ、ローカル環境で作業することが可能になりました 💻

いかがでしょう？

@kagomen
Copy link
Member

kagomen commented Apr 5, 2024

文の強調というか、コピーなどを表記するのに使われることは、時々？あります！
（少なくとも、自分独自の書き方ではないということです！）

そうなんですね！💡
ご教授ありがとうございます！🙏

@kagomen
Copy link
Member

kagomen commented Apr 5, 2024

各STEPの「これにより〜」という要約的な文章を、
以下のように強調して書く形で、一旦いいかもしれないと思いました！

目立って良いと思います！🚀
概念の詳しい説明は、必要な時・できそうな時にやる、という感じでも良さそうですね！（少なくとも、このイシューとは切り分けた方が良さそうと思いました）

@kazzyfrog
Copy link
Member Author

目立って良いと思います！🚀
概念の詳しい説明は、必要な時・できそうな時にやる、という感じでも良さそうですね！（少なくとも、このイシューとは切り分けた方が良さそうと思いました）

ですね！
一旦、「これにより〜」という要約的な文章を、強調して書く形で進めようと思います！！👍

@kazzyfrog
Copy link
Member Author

一旦、「これにより〜」という要約的な文章を、強調して書く形で進めようと思います！！👍

修正しました！！

kagomen
kagomen approved these changes Apr 5, 2024
View reviewed changes
Copy link
Member

@kagomen kagomen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@kagomen kagomen merged commit bbca93b into main Apr 5, 2024
@kagomen kagomen deleted the docs/#165-fix-tutorial branch April 5, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pss-aileen pss-aileen pss-aileen left review comments

@kagomen kagomen kagomen approved these changes

Assignees

No one assigned

Labels

Type: 📚 docs ドキュメント作成、追記に関するもの

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

ドッグフーディングより、READMEの修正

4 participants

@kazzyfrog @kagomen @pss-aileen