Skip to content

パイロット指摘の反映: 手順リンクの視認性 / PowerShellでの引用符 - #6

Open
Tivo0921 wants to merge 1 commit into
mainfrom
docs/fix-pilot-feedback
Open

Tivo0921 wants to merge 1 commit into
mainfrom
docs/fix-pilot-feedback

Conversation

@Tivo0921

Copy link
Copy Markdown
Contributor

What

Issue #4(パイロット / 教材レビュー)でいただいた指摘2点を教材に反映しました。

Why

  1. 「手順」がリンクだと気付けず、exercises/ を参照すべきことに辿り着けなかった
    進行表Issueで — [手順](...) と見出し末尾に埋め込まれていたため、リンクだと認識されにくい状態でした。実習の本体は exercises/ 配下なので、ここで詰まると研修全体が進みません。

  2. PowerShellで git stash show -p stash@{0} がエラーになる
    PowerShellは @{ を自身の記法として解釈するため、引用符なしではGitに届く前にエラーになります。Windowsユーザーは全員ここで止まります。

Changes

1. 手順書リンクの視認性

  • .github/ISSUE_TEMPLATE/training.yml
    • 各Stepの見出し末尾の — [手順](...) を廃止し、見出し直下に独立した行として
      👉 **手順書を開く: [exercises/01-clone-to-pr.md](...)** を配置
    • リンクテキストを「手順」からファイルパスそのものに変更
    • 冒頭に「チェックリストだけでは進められない」旨の注意を追加
  • README.md の「研修の進め方」にも同じ趣旨を明記

2. PowerShellでの引用符

  • exercises/05-stash.md: git stash show -p "stash@{0}" に修正+注意書き
  • exercises/07-undo-commit.md: git reset --hard "HEAD@{1}" に修正+注意書き(同じ理由で同じエラーになるため)
  • docs/03-setup.md: 「7. Windows(PowerShell)を使う場合の注意」を新設(既存の「7. GitHubへの認証」は8へ繰り下げ)
  • docs/06-troubleshooting.md: 「よくある状況と対処」に項目追加
  • docs/99-cheatsheet.md: 該当箇所に注記追加

引用符付きの書き方はmacOS / Linux / Git Bashでもそのまま動くため、全環境で統一しています。

How to Test

  • .github/ISSUE_TEMPLATE/training.yml から新しくIssueを1件作成し、👉 の行が各Stepに表示され、リンク先がファイル名として読めることを確認
  • PowerShell環境があれば git stash show -p "stash@{0}" が通ることを確認
  • 追加したアンカーリンク(03-setup.md#7-windowspowershellを使う場合の注意)が飛ぶことを確認

Check

  • 自分で動作確認した
  • git diff を見て、不要な変更が入っていないことを確認した
  • Secret(API Key / Password / Token / .env など)をCommitしていない
  • Commit Messageが「何を変更したか」分かる内容になっている
  • 1つのPull Requestに複数の目的を混ぜていない

Related

Refs #4

指摘してくれた @Rika-0114 にレビューをお願いできると確実です。

なお、作成済みのIssue #2 / #4 の本文はテンプレート変更では自動更新されないため、そのままにしています。

🤖 Generated with Claude Code

Issue #4 のパイロット指摘2点への対応。

1. 「手順」リンクに気付きにくい
   - Issue テンプレートの各Stepを「👉 手順書を開く: exercises/xx.md」の
     独立した行に変更し、リンク先のファイル名を明示
   - テンプレート冒頭とREADMEに「チェックリストだけでは進められない」旨を追記

2. PowerShellで stash@{0} / HEAD@{1} がエラーになる
   - 05-stash.md / 07-undo-commit.md のコマンドを引用符付きに修正
   - 03-setup.md に「Windows(PowerShell)を使う場合の注意」を追加
   - 06-troubleshooting.md / 99-cheatsheet.md にも同じ注意を追記

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

### Step 2. 実習1: CloneからPull Requestまで — [手順](https://github.com/Lumos-Programming/github-practice/blob/main/exercises/01-clone-to-pr.md)
### Step 2. 実習1: CloneからPull Requestまで

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

しっかり対処ができていると思います。
対応、ありがとうございます

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants