ドキュメントに絵文字を追加しました。

.vscode/settings.json

@@ -2,6 +2,8 @@
   "cSpell.words": [
     "asctime",
     "astype",
+    "codeql",
+    "Colab",
     "dtype",
     "fromarray",
     "Gradio",

README.md

@@ -7,33 +7,33 @@ colorFrom: yellow
 colorTo: yellow
 pinned: false
 ---
-# SaliencyMap — in Python
+# 📖 SaliencyMap — in Python
 ![Python version](https://img.shields.io/badge/python-3.9+-important)
 <a href="https://colab.research.google.com/github/umyuu/SaliencyMapDemo/blob/main/scripts/launch_app.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
 
-## 概要  
+## 📝 概要  
 画像における注目すべき領域を可視化する「顕著性マップ」を表示するデモアプリです。  
 私は画像処理についてはまだ初心者ですが、この技術に興味があります。  
 本アプリは、opencv-contribパッケージの`cv2.saliency.StaticSaliencySpectralResidual`を関数を実行するラッパーアプリです。  
 
-## 使い方  
+## 🚀 使い方  
 ### a. Google Colabで実行  
 <a href="https://colab.research.google.com/github/umyuu/SaliencyMapDemo/blob/main/scripts/launch_app.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>をクリックして、簡単に実行できます。  
 
 ### b. アプリをダウンロードして実行  
-#### システム要件  
+#### 💻 システム要件  
 - 必要ディスク容量：500MB(Pythonを含みません)  
 - Python のダウンロード:https://www.python.org/downloads/  
 
-#### 導入方法  
+#### 📥 導入方法  
 ##### 1. セットアップ  
-1. [Releases](https://github.com/umyuu/SaliencyMapDemo/releases)ページを開き、一番上の `Assets` 欄にある `Source code (zip)` をダウンロードして展開します。  
+1. [Releases](/releases)ページを開き、一番上の `Assets` 欄にある `Source code (zip)` をダウンロードして展開します。  
 2. `01-installation.bat`ファイルをダブルクリックします。  
 ##### 2. 実行  
 `run.bat`ファイルをダブルクリックします。  
 ブラウザが自動起動し、http://127.0.0.1:9999 にアクセスできます。  
 
-**トラブルシューティング**  
+**🔧 トラブルシューティング**  
 - アプリが起動しない場合  
 	既定のポート番号 (9999) が使用されている可能性があります。  
 	メモ帳で `run.bat` ファイルを開き、以下の行の `9999` を別の数字 (例: 8888) に変更して上書き保存します。  
@@ -44,10 +44,10 @@ pinned: false
 	~~~
 	python app.py --server_port 8888  
 	~~~
-##### 補足事項  
+##### 💡 補足事項  
 - アプリをダウンロードして実行の場合は、画像処理はローカル環境で行われます。画像は外部に送信されません。  
 
-##### アンインストール  
+##### 🗑️ アンインストール  
 以下の手順でアンインストールできます。  
 1. アプリのフォルダを丸ごと削除します。  
 2. アプリで処理した画像は一時フォルダに残ります。不要な場合は削除してください。  
@@ -57,5 +57,8 @@ pinned: false
 	C:\Users\%USERNAME%\AppData\Local\Temp\gradio
 	~~~
 
-## Source code License.  
+## 🤝 コントリビューターガイドライン  
+[CONTRIBUTING](docs/CONTRIBUTING.md)  
+
+## 📜 Source code License.  
 [MIT License](LICENSE)  

docs/CONTRIBUTING.md

@@ -1,11 +1,11 @@
-# Contributing Guide  
+# 📖 Contributing Guide  
 ## 🎉 ようこそ！  
 このプロジェクトへの関心と貢献に感謝します！あなたの貢献は、このプロジェクトを改善し、コミュニティを成長させるのに大いに役立ちます。このガイドは、プロジェクトへの貢献をスムーズに進めるためのものです。  
 
 ## 📚 概要
 このガイドでは、リポジトリの構成、プルリクエストの作成方法、バグ報告の方法、およびコーディング規約について説明します。これらのガイドラインを理解し、遵守することで、あなたの貢献がプロジェクトにとって最大の価値を持つことができます。  
 
-## 🧱 リポジトリ構成  
+## 🏗️ リポジトリ構成  
 - 📂`/src`: Pythonソースコード。  
      主要な機能のコードが含まれています。  
 - 🧪`/test`: Pythonの単体テストコード。