From 167c627427c3193ba86ac973fd543b5abaf5e4b0 Mon Sep 17 00:00:00 2001
From: Mojmir Vinkler <mojmir.vinkler@gmail.com>
Date: Thu, 19 Dec 2024 14:20:57 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9D=20Add=20commit=20message=20generat?=
 =?UTF-8?q?ion=20instructions=20for=20Copilot=20(#3745)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 🐝 Add commit message generation instructions for Copilot
---
 .copilot-commit-message-instructions.md | 48 +++++++++++++++++++++++++
 .vscode/settings.json                   |  5 +++
 2 files changed, 53 insertions(+)
 create mode 100644 .copilot-commit-message-instructions.md

diff --git a/.copilot-commit-message-instructions.md b/.copilot-commit-message-instructions.md
new file mode 100644
index 00000000000..94309811838
--- /dev/null
+++ b/.copilot-commit-message-instructions.md
@@ -0,0 +1,48 @@
+## Commit Message Instructions
+
+Start your commit message with a **category emoji** from the list below to describe the purpose of the change.
+
+Format: `<emoji>: <message>`
+
+Examples:
+✨ Add new search functionality
+🐛 Fix crash when uploading files
+
+### Categories
+
+- 📊 **Data**: Updates or adds data.
+  Example: `📊 Update population dataset`
+
+- 🐛 **Bug**: Fixes a user-facing bug.
+  Example: `🐛 Fix broken link in footer`
+
+- 🔨 **Refactor**: Changes code without fixing bugs or adding features.
+  Example: `🔨 Refactor chart rendering logic`
+
+- ✨ **Enhance**: Improves existing functionality.
+  Example: `✨ Improve chart loading speed`
+
+- 🎉 **Feature**: Adds a new user-facing feature.
+  Example: `🎉 Add dark mode support`
+
+- 📜 **Docs**: Updates or adds documentation.
+  Example: `📜 Add setup guide for developers`
+
+- 🧹 **Chore**: Maintenance tasks like dependency updates.
+  Example: `🧹 Update Node.js to latest version`
+
+- 💄 **Style**: Formatting or linting changes.
+  Example: `💄 Fix inconsistent indentation`
+
+- 🚧 **WIP**: Work in progress for future commits.
+  Example: `🚧 Add initial layout for dashboard`
+
+- ✅ **Tests**: Adds or refactors tests.
+  Example: `✅ Add missing unit tests`
+
+---
+
+### Tips
+- Keep messages concise and clear.
+- Use one emoji per commit for clarity.
+- Split changes into separate commits if needed.
diff --git a/.vscode/settings.json b/.vscode/settings.json
index cb06b055745..3f21ee9981b 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -45,5 +45,10 @@
   "yaml.format.printWidth": 999,
   "ruff.path": [
     ".venv/bin/ruff"
+  ],
+  "github.copilot.chat.commitMessageGeneration.instructions": [
+    {
+      "file": ".copilot-commit-message-instructions.md"
+    }
   ]
 }