Conversation
K-shir0
left a comment
There was a problem hiding this comment.
見ると文書としておかしい部分が多々あるのでマークダウンをプレビューしながら書くと良いですよ。
あとドキュメントの想定読者のレベルを考えながら書けるともっと良い手順書が書けると思います。
忘れないように issue を立てた方が良さそう。お任せします。 |
|
git pull しようとしたときに、謎のエラーに遭遇して何回もコミットしてしまいました、すみませんでした。 |
K-shir0
left a comment
There was a problem hiding this comment.
ごり押しな記法が目立ちます。
基本的な記法はざっと公式ドキュメントを目を通すと良いですよ。
git_install/README.md
Outdated
|
|
||
| ## Windows | ||
| 1. まず,[Gitをインストール](https://git-scm.com/download/win)する | ||
| -  |
There was a problem hiding this comment.
リストに画像がひっついてるの違和感があります。文章以外には基本使わないです。
git_install/README.md
Outdated
|
|
||
| ## profile 設定 Mac $ Windows 共通 (WindowsはBash ,MacはTerminal) | ||
| 1. ユーザー名(`user.name`)とメールアドレス(`user.email`)を登録します | ||
| 2. `git config --global user.name "自分だとわかる名前を入れてください"`を打って`Git`にユーザー名を登録します |
There was a problem hiding this comment.
日本語にするよりも
後の文に "Your Name には Git で使用するユーザ名を入力して下さい"などの方が良いと思います。
git_install/README.md
Outdated
| @@ -0,0 +1,37 @@ | |||
| # GitをダウンロードしてGitHubを使ってみファイル管理をしてみよう01 | |||
|
|
|||
| ## Windows | |||
There was a problem hiding this comment.
ヘッダーの後は改行を入れた方が見た目が良くなります👈
git_install/README.md
Outdated
| 1. ユーザー名(`user.name`)とメールアドレス(`user.email`)を登録します | ||
| 2. `git config --global user.name "自分だとわかる名前を入れてください"`を打って`Git`にユーザー名を登録します | ||
| `Git`にユーザー名を登録しておくことで、コミット時の名前を表示できます | ||
| - *例* `git config --global user.name "Yoshiki"` |
There was a problem hiding this comment.
タブを追加して階層化しましょう
| - *例* `git config --global user.name "Yoshiki"` | |
| - *例* `git config --global user.name "Yoshiki"` |
git_install/README.md
Outdated
| `Git`にユーザー名を登録しておくことで、コミット時の名前を表示できます | ||
| - *例* `git config --global user.name "Yoshiki"` | ||
| 3. `git config --global user.email "自分のメールアドレス入力してください"`を打って`Git`にメールアドレスを登録します | ||
| - *例* `git config --global user.email "wtfWasThat@gmail.com"` |
|
あと他人の Markdown (Qiita, Github レポジトリ)を参考にしながら書くなどすると向上すると思います。 参考例 |
ボリューム感がやや多いかと思いましたので、01でgit,02でgit hubに分けて作ろうかと思います