Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/docs-quality-gate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:
- ".github/**"
- "scripts/**"
- "package.json"
- "package-lock.json"
- "AI_USAGE_POLICY.md"
- "AGENTS.md"
- "CONTRIBUTING.md"
Expand All @@ -21,6 +22,7 @@ on:
- ".github/**"
- "scripts/**"
- "package.json"
- "package-lock.json"
- "AI_USAGE_POLICY.md"
- "AGENTS.md"
- "CONTRIBUTING.md"
Expand All @@ -44,10 +46,15 @@ jobs:
uses: actions/setup-node@v6
with:
node-version: "20"
cache: npm
cache-dependency-path: package-lock.json

- name: Install dependencies
run: npm ci --no-fund --no-audit

- name: Dependency audit
run: npm audit

- name: Collect changed Markdown files (docs/manuscript/etc)
id: changes
shell: bash
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
node_modules/
_site/
docs/_site/
.jekyll-cache/
.jekyll-metadata
.bundle/
vendor/bundle/
Gemfile.lock
docs/Gemfile.lock
.sass-cache/
.DS_Store
*.log
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ git clone https://github.com/itdojp/github-guide-for-beginners-book.git
cd github-guide-for-beginners-book

# 依存関係をインストール(package-lock.json と同期)
# Node.js 20.18.1+ を利用(QA依存の cheerio / undici が要求)
npm ci

# 公開サイトをローカルビルドする場合のRuby依存関係
Expand All @@ -97,6 +98,7 @@ npm run build
npm run check:metadata
npm test
npm run docs:quality-gate
npm audit
```

## 📝 執筆ガイドライン
Expand Down
44 changes: 22 additions & 22 deletions docs/appendices/appendix-github-shortcuts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ order: 101
### ページ移動ショートカット

| ショートカット | 説明 | 使用場面 |
|---|---|---|
| --- | --- | --- |
| `g` + `c` | コードページに移動 | リポジトリのファイルを見たい時 |
| `g` + `i` | Issuesページに移動 | 課題を確認・作成したい時 |
| `g` + `p` | Pull Requestsページに移動 | PRを確認・作成したい時 |
Expand All @@ -25,7 +25,7 @@ order: 101
### サイト内検索

| ショートカット | 説明 | 使用例 |
|---|---|---|
| --- | --- | --- |
| `s` または `/` | 検索ボックスにフォーカス | ファイルやリポジトリを検索 |
| `command` + `k` (Mac)<br>`ctrl` + `k` (Windows) | 高速検索パレット | 任意のリポジトリに即座に移動 |

Expand All @@ -36,7 +36,7 @@ order: 101
### ファイル操作

| ショートカット | 説明 | 便利な使い方 |
|---|---|---|
| --- | --- | --- |
| `t` | ファイルファインダーを開く | 大きなプロジェクトで特定ファイルを検索 |
| `w` | ブランチ・タグ選択画面を開く | 異なるブランチに素早く切り替え |
| `l` | 特定の行にジャンプ | コードレビュー時にライン番号指定 |
Expand All @@ -45,7 +45,7 @@ order: 101
### ファイルビューア内

| ショートカット | 説明 | 使用場面 |
|---|---|---|
| --- | --- | --- |
| `j` | 次のファイルに移動 | 複数ファイルの変更を順番に確認 |
| `k` | 前のファイルに移動 | ファイル間を行き来しながらレビュー |
| `escape` | ファイル選択を解除 | 通常の画面操作に戻る |
Expand All @@ -57,7 +57,7 @@ order: 101
### 一覧画面

| ショートカット | 説明 | 効率的な使い方 |
|---|---|---|
| --- | --- | --- |
| `c` | 新しいIssue/PRを作成 | マウスを使わずに即座に作成開始 |
| `j` | 次のアイテムを選択 | キーボードだけでリスト操作 |
| `k` | 前のアイテムを選択 | 上下移動で効率的に確認 |
Expand All @@ -66,7 +66,7 @@ order: 101
### Issue・PR詳細画面

| ショートカット | 説明 | 使用例 |
|---|---|---|
| --- | --- | --- |
| `a` | 自分を担当者に割り当て | 自分が対応するIssueを即座に担当 |
| `l` | ラベル編集画面を開く | カテゴリ分けを素早く実行 |
| `m` | マイルストーン設定画面を開く | プロジェクト管理での分類 |
Expand All @@ -79,7 +79,7 @@ order: 101
### Pull Request レビュー画面

| ショートカット | 説明 | レビュー効率化 |
|---|---|---|
| --- | --- | --- |
| `j` | 次の差分に移動 | 変更箇所を順番に確認 |
| `k` | 前の差分に移動 | 前の変更に戻って再確認 |
| `shift` + `j` | 次のファイルに移動 | ファイル単位での確認 |
Expand All @@ -89,7 +89,7 @@ order: 101
### レビューコメント

| ショートカット | 説明 | 使用場面 |
|---|---|---|
| --- | --- | --- |
| `ctrl` + `enter` | コメントを送信 | 入力後の素早い送信 |
| `ctrl` + `shift` + `p` | プレビューと編集を切り替え | Markdown記法の確認 |
| `r` | 引用返信 | 既存コメントへの返答 |
Expand All @@ -101,7 +101,7 @@ order: 101
### テキスト装飾

| ショートカット | 説明 | 結果 |
|---|---|---|
| --- | --- | --- |
| `ctrl` + `b` | 太字 | **太字テキスト** |
| `ctrl` + `i` | 斜体 | *斜体テキスト* |
| `ctrl` + `k` | リンク挿入 | [リンクテキスト](https://example.com) |
Expand All @@ -111,7 +111,7 @@ order: 101
### コードブロック

| ショートカット | 説明 | 使用例 |
|---|---|---|
| --- | --- | --- |
| `ctrl` + `e` | インラインコード | `code` |
| `ctrl` + `shift` + `c` | コードブロック | ```javascript<br>code<br>``` |
| ``` ` ` ` ``` + 言語名 | シンタックスハイライト | 言語別の色付け |
Expand All @@ -123,7 +123,7 @@ order: 101
### Issue・PR検索

| 検索クエリ | 説明 | 使用例 |
|---|---|---|
| --- | --- | --- |
| `is:open` | オープンなもののみ | 現在対応中の課題を表示 |
| `is:closed` | クローズされたもののみ | 完了した作業を確認 |
| `author:username` | 特定ユーザーが作成 | 特定の人の作業を追跡 |
Expand All @@ -134,7 +134,7 @@ order: 101
### コード検索

| 検索クエリ | 説明 | 活用場面 |
|---|---|---|
| --- | --- | --- |
| `filename:package.json` | ファイル名で検索 | 設定ファイルを探す |
| `extension:js` | 拡張子で検索 | 特定言語のファイルのみ |
| `path:src/components` | パスで検索 | 特定ディレクトリ内を検索 |
Expand All @@ -147,7 +147,7 @@ order: 101
### 通知管理ショートカット

| ショートカット | 説明 | 通知効率化 |
|---|---|---|
| --- | --- | --- |
| `j` | 次の通知を選択 | 通知一覧をキーボードで操作 |
| `k` | 前の通知を選択 | 上下移動での確認 |
| `e` または `y` | 通知を既読にする | 確認済みマーク |
Expand All @@ -157,7 +157,7 @@ order: 101
### ウォッチング設定

| 操作 | 説明 | 推奨設定 |
|---|---|---|
| --- | --- | --- |
| Watch | すべての活動を通知 | 重要なプロジェクトのみ |
| Unwatch | 通知を受け取らない | 関係ないプロジェクト |
| Ignore | 一切の通知を無視 | 完全に無関係なプロジェクト |
Expand All @@ -170,7 +170,7 @@ order: 101
### GitHub Projects(新版)

| ショートカット | 説明 | プロジェクト管理での活用 |
|---|---|---|
| --- | --- | --- |
| `c` | 新しいアイテムを作成 | タスクやIssueの即座作成 |
| `ctrl` + `space` | コマンドパレットを開く | 高速なアクション実行 |
| `d` | アイテムをドラフトに変更 | アイデア段階での保存 |
Expand All @@ -179,7 +179,7 @@ order: 101
### フィルタリング

| フィルター | 説明 | 使用例 |
|---|---|---|
| --- | --- | --- |
| `assignee:@me` | 自分が担当 | 自分のタスクのみ表示 |
| `status:"In Progress"` | 特定ステータス | 進行中の作業のみ |
| `label:bug` | 特定ラベル | バグ対応のみ表示 |
Expand All @@ -192,7 +192,7 @@ order: 101
### モバイルWebでの便利機能

| 機能 | 操作方法 | 活用場面 |
|---|---|---|
| --- | --- | --- |
| ファイル検索 | 画面上部の検索アイコン | 外出先でのコード確認 |
| コードビューア | ピンチズームで拡大 | 小さな画面でのコード読み |
| 通知確認 | ベルアイコンをタップ | 移動中の通知チェック |
Expand All @@ -201,7 +201,7 @@ order: 101
### アクセシビリティ機能

| 機能 | 説明 | 対象ユーザー |
|---|---|---|
| --- | --- | --- |
| ハイコントラストモード | 視認性の向上 | 視覚に配慮が必要な方 |
| キーボードナビゲーション | マウス不要の操作 | 全ユーザー・効率重視 |
| スクリーンリーダー対応 | 音声読み上げ対応 | 視覚障害のある方 |
Expand All @@ -214,7 +214,7 @@ order: 101
### 推奨ブラウザ拡張機能

| 拡張機能名 | 機能 | 効果 |
|---|---|---|
| --- | --- | --- |
| Refined GitHub | UI/UX改善 | より使いやすいインターフェース |
| Octotree | ファイラー表示 | サイドバーでファイル一覧 |
| GitHub Dark Theme | ダークテーマ | 目に優しい表示 |
Expand All @@ -223,7 +223,7 @@ order: 101
### 開発者ツール活用

| ツール | 使用方法 | デバッグ活用 |
|---|---|---|
| --- | --- | --- |
| ブラウザDevTools | F12キー | GitHub APIの通信確認 |
| ネットワークタブ | 通信ログ確認 | ページ読み込み速度分析 |
| コンソール | JavaScript実行 | カスタムスクリプト実行 |
Expand Down Expand Up @@ -283,7 +283,7 @@ order: 101
### よくある問題の解決

| 問題 | ショートカット解決法 | 補足 |
|---|---|---|
| --- | --- | --- |
| ページが重い | `shift` + `F5` (強制リロード) | キャッシュクリア効果 |
| 検索が見つからない | `s` → 詳細検索オプション | 高度な検索条件設定 |
| 通知が多すぎる | 通知設定の見直し | カスタム通知で最適化 |
Expand All @@ -292,7 +292,7 @@ order: 101
### パフォーマンス最適化

| 問題 | 対策 | 効果 |
|---|---|---|
| --- | --- | --- |
| 読み込みが遅い | 不要なタブを閉じる | メモリ消費削減 |
| 操作が重い | ブラウザ拡張機能を無効化 | 処理速度向上 |
| 画面が見づらい | ズーム調整 (Ctrl + +/-) | 視認性向上 |
Expand Down
Loading
Loading