From b1201166c656ab01682fc4399ec4b4cf3c1e7e0b Mon Sep 17 00:00:00 2001 From: Ryosuke Igarashi Date: Wed, 21 Aug 2024 17:41:50 +0900 Subject: [PATCH] =?UTF-8?q?Contribution.md=E3=81=AE=E5=86=85=E5=AE=B9?= =?UTF-8?q?=E3=82=92zenn-docs-for-developers=E3=81=AB=E7=A7=BB=E8=A1=8C?= =?UTF-8?q?=E3=81=97=E3=81=BE=E3=81=97=E3=81=9F=20https://github.com/zenn-?= =?UTF-8?q?dev/zenn-docs-for-developers/pull/7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 83 -------------------------------- 2 files changed, 1 insertion(+), 84 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 473fa62..ad6c156 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,7 +8,7 @@ Resolves # プルリクエストを作成いただく際、お手数ですが以下の内容についてご確認をお願いします。 -- [ ] :book: [Contribution Guide](https://github.com/zenn-dev/zenn-vscode-extension/blob/main/CONTRIBUTING.md) を読んだ +- [ ] :book: [Contribution Guide](https://zenn-dev.github.io/zenn-docs-for-developers/contribution) を読んだ - [ ] :woman_technologist: `canary` ブランチに対するプルリクエストである - [ ] 実行して正しく動作しているか確認する - [ ] 不要なコードが含まれていないか( コメントやログの消し忘れに注意 ) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 174553d..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,83 +0,0 @@ -# Contribution Guide - -## 🚩 注意 - -この VSCode 拡張は β 版です。 -予告無しにリポジトリの内容が大幅に変更されたり削除される可能性があります。 - -## Issues - -- zenn.dev に関する問題や改善提案は [zenn-community](https://github.com/zenn-dev/zenn-community/issues) の Issues をご利用ください。 -- zenn-vscode-extension に関する問題や改善の提案については [zenn-community](https://github.com/zenn-dev/zenn-community/issues) もしくは本リポジトリの Issues をご利用ください。 - -## Pull Requests - -- レビューに時間がかかる場合やマージを行わずにクローズする場合があります。特に機能追加に関してはあらかじめ Issues で議論させていただければと思います。 - -### PR 作成時の注意点 - -- `canary`ブランチに対して作成してください。 -- それ以外のブランチはクローズさせて頂きます。 - -## リリースフロー - -- canary ブランチから main ブランチに PR を作成します - - release ラベルを付与 -- canary ブランチにバージョンアップのコミットを追加します - - バージョンコミットがない場合は Bot によって注意されます -- main ブランチにマージされると拡張が自動リリースされます - -### Develop - -#### インストール方法 - -このリポジトリをクローンし、以下のコマンドを実行します。 - -``` -$> pnpm install -``` - -実行が完了したら、以下のコマンドで動作確認できます。 - -``` -$> pnpm dev -``` - -> **Note** -> このとき、[VSCode Insiders](https://code.visualstudio.com/insiders/) がインストールされます。 - -上記のコマンドを実行すると、以下の画像のようなブラウザが開き、このリポジトリ内の `./examples` 内を表示されます。 - -![](https://user-images.githubusercontent.com/97154037/191165110-ff7b0fad-5692-4288-94bd-f8d0f93463f7.png) - -#### デバッグ方法 - -> **Warning** -> デバッグには VSCode を使用していることを前提にしています。 - -VSCode 上でデバッグビューを開き、`Run Web Extension` を選択します。 - -![](https://user-images.githubusercontent.com/97154037/191164796-9f4a0fe9-0159-4393-a583-acfc2a112b57.png) - -次に、F5 キーまたはデバッグ実行ボタンを押すと、別の VSCode ウィンドウが開き、そこでデバッグすることができます。 - -![](https://user-images.githubusercontent.com/97154037/191164493-94e8b9bc-ff4c-47e9-8e20-ede95ccade40.png) - -#### ブレークポイントを打つ - -このリポジトリを開いている VSCode で、停止したい箇所にブレークポイントを打ちます。(※ 拡張がインストールされている VSCode ではない点に注意) - -![](https://user-images.githubusercontent.com/97154037/191165270-0deb7021-2dcf-4383-92ca-b8b9d08d5267.png) - -次にデバッグを開始し、新規に開かれた VSCode のウィンドウで `開発者ツールの切り替え` を実行し、Dev Tools を表示します。ブラウザで開いている場合は、F12 キーを押すことで Dev Tools を表示できます。 - -![](https://user-images.githubusercontent.com/97154037/191165959-d6f49f60-3b14-416a-af7f-40b68121155c.png) - -この状態で処理を実行すると、ブレークポイントを打った箇所で処理が停止しますが、デバッグ画面はこのリポジトリを開いている VSCode であることに注意してください。 - -> **Note** -> ブレークポイントが機能していない場合は、`Developer: Reload Window` コマンドを実行すると上手くいく可能性があります。 - -#### Hot Reload - -デバッグ中は Hot Reload が有効ですが、変更を適用するには Zenn の拡張がインストールされている VSCode ウィンドウで `Developer: Reload Window` を実行する必要があります。