From efceea7c26b81702295143acaa68e952489f2712 Mon Sep 17 00:00:00 2001
From: Pavel Vernigorov <22795961+shpingalet007@users.noreply.github.com>
Date: Wed, 12 Jun 2024 09:23:45 +0200
Subject: [PATCH] repo: templates for pull requests (#1246)

Co-authored-by: Andy Oknen <andy.oknen@yandex.ru>
---
 .github/PULL_REQUEST_TEMPLATE.md              | 55 +++++++------------
 .../PULL_REQUEST_TEMPLATE/DOCUMENTATION.md    | 18 ++++++
 .github/PULL_REQUEST_TEMPLATE/FEATURE.md      | 22 ++++++++
 .github/PULL_REQUEST_TEMPLATE/FIX.md          | 22 ++++++++
 .github/PULL_REQUEST_TEMPLATE/HOTFIX.md       | 22 ++++++++
 .github/PULL_REQUEST_TEMPLATE/MAINTENANCE.md  | 20 +++++++
 .github/PULL_REQUEST_TEMPLATE/PATCH.md        | 22 ++++++++
 .github/PULL_REQUEST_TEMPLATE/REFACTORING.md  | 19 +++++++
 8 files changed, 164 insertions(+), 36 deletions(-)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/DOCUMENTATION.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/FEATURE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/FIX.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/HOTFIX.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/MAINTENANCE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/PATCH.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/REFACTORING.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index f9ddfdd8df..0f3735d777 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,36 +1,19 @@
-## Standards checklist:
-
-<!---
-
-Pull request must have next naming format:
-  - For fixes use "fix:" prefix, e.g. "fix: video transcoding"
-  - For patches use "patch:" prefix, e.g. "patch: docker image change"
-  - For features use "feat:" prefix, e.g. "feat: voice messages"
-  - For refactoring use "refactor:" prefix, e.g. "refactor: workflow actions"
-  - For documentation use "docs:" prefix, e.g. "docs: readme.md header logo"
-
-// TODO: Airbnb code style guide
-
--->
-
-<!-- Fill with an x the ones that apply. Example: [x] -->
-
-- [ ] The PR title is descriptive.
-- [ ] The PR doesn't replicate another PR which is already open.
-- [ ] The PR has self-explained commits history.
-<!--
-- [ ] I have read the contribution guide and followed all the instructions.
-- [ ] The code follows the code style guide detailed in the wiki.
--->
-- [ ] The code is mine or it's from somewhere with an Apache-2.0 compatible license.
-- [ ] The code is efficient, to the best of my ability, and does not waste computer resources.
-- [ ] The code is stable and I have tested it myself, to the best of my abilities.
-- [ ] If the code introduces new classes, methods, I provide a valid use case for all of them.
-
-## Changes:
-
-- [...]
-
-## Other comments:
-
-...
+<!-- 📣    SELECT PR TEMPLATE IN PREVIEW TAB    📣 -->
+<!-- 📣 WE WOULD CLOSE THE PR IF YOU DON'T READ 📣 -->
+
+### ✏️ Select the appropriate PR template
+* [Feature](?expand=1&template=FEATURE.md&title=feat%3A%20fill%20here%20the%20pr%20title&labels=contribution%20type%3A%20%E2%9C%A8%20feature)
+* [Patch](?expand=1&template=PATCH.md&title=patch%3A%20fill%20here%20the%20pr%20title&labels=contribution%20type%3A%20%F0%9F%A7%A9%20patch)
+* [Fix](?expand=1&template=FIX.md&title=fix%3A%20fill%20here%20the%20pr%20title&labels=contribution%20type%3A%20%F0%9F%90%9B%20fix)
+* [Hotfix](?expand=1&template=HOTFIX.md&title=hotfix%3A%20fill%20here%20the%20pr%20title&labels=contribution%20type%3A%20%F0%9F%94%A5%20hotfix)
+
+### ✏️ Only for assigned developers
+* [Maintenance](?expand=1&template=MAINTANANCE.md&title=repo%3A%20fill%20here%20the%20pr%20title&labels=contribution%20type%3A%20%F0%9F%9A%A6%20maintanance)
+* [Documentation](?expand=1&template=DOCUMENTATION.md&title=docs%3A%20fill%20here%20the%20pr%20title&labels=contribution%20type%3A%20%F0%9F%93%96%20documentation)
+* [Refactoring](?expand=1&template=REFACTORING.md&title=refactor%3A%20fill%20here%20the%20pr%20title&labels=contribution%20type%3A%20%F0%9F%92%8E%20refactoring)
+
+###### _* Ignore annotation below during the template selection step_
+---
+> # ⚠️ Developer Did Not Follow Instructions ⚠️
+> #### This annotation indicates that the developer overlooked selecting the appropriate template for their PR. This suggests that the developer may have rushed to push their changes. Senior developers should take note and review the PR more closely. If this mistake is noticed, the developer should promptly correct the PR with the appropriate template. Repeated occurrences of this may result in the closure of the author's future PRs.
+---
\ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE/DOCUMENTATION.md b/.github/PULL_REQUEST_TEMPLATE/DOCUMENTATION.md
new file mode 100644
index 0000000000..b79a828662
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/DOCUMENTATION.md
@@ -0,0 +1,18 @@
+<!--
+📣 READ CAREFULLY BEFORE CREATING THIS PR 📣
+1️⃣ This PR template is exclusively for DOCUMENTATION
+2️⃣ The PR title must start from "docs:"
+3️⃣ The PR title must be written in lowercase
+4️⃣ The topic must be provided with requested below information
+-->
+
+## Standards checklist:
+- [ ] The PR title is descriptive
+- [ ] There is no PR that addresses this issue
+- [ ] The PR has self-explained commits history
+
+## Changes:
+...
+
+## Other comments:
+...
diff --git a/.github/PULL_REQUEST_TEMPLATE/FEATURE.md b/.github/PULL_REQUEST_TEMPLATE/FEATURE.md
new file mode 100644
index 0000000000..62bd0a8abc
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/FEATURE.md
@@ -0,0 +1,22 @@
+<!--
+📣 READ CAREFULLY BEFORE CREATING THIS PR 📣
+1️⃣ This PR template is exclusively for FEATURE
+2️⃣ The PR title must start from "feat:"
+3️⃣ The PR title must be written in lowercase
+4️⃣ The topic must be provided with requested below information
+-->
+
+## Standards checklist:
+- [ ] The PR title is descriptive
+- [ ] There is no PR that addresses this issue
+- [ ] The PR has self-explained commits history
+- [ ] The code is mine or has Apache-2.0 compatible license
+- [ ] The code is efficient enough, it respects user resources
+- [ ] The code is stable and tested
+- [ ] There is new functionality, information is provided below
+
+## Changes:
+...
+
+## Other comments:
+...
diff --git a/.github/PULL_REQUEST_TEMPLATE/FIX.md b/.github/PULL_REQUEST_TEMPLATE/FIX.md
new file mode 100644
index 0000000000..8b7a58d447
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/FIX.md
@@ -0,0 +1,22 @@
+<!--
+📣 READ CAREFULLY BEFORE CREATING THIS PR 📣
+1️⃣ This PR template is exclusively for FIX
+2️⃣ The PR title must start from "fix:"
+3️⃣ The PR title must be written in lowercase
+4️⃣ The topic must be provided with requested below information
+-->
+
+## Standards checklist:
+- [ ] The PR title is descriptive
+- [ ] There is no PR that addresses this issue
+- [ ] The PR has self-explained commits history
+- [ ] The code is mine or has Apache-2.0 compatible license
+- [ ] The code is efficient enough, it respects user resources
+- [ ] The code is stable and tested
+- [ ] There is new functionality, information is provided below
+
+## Changes:
+...
+
+## Other comments:
+...
diff --git a/.github/PULL_REQUEST_TEMPLATE/HOTFIX.md b/.github/PULL_REQUEST_TEMPLATE/HOTFIX.md
new file mode 100644
index 0000000000..04e0caca97
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/HOTFIX.md
@@ -0,0 +1,22 @@
+<!--
+📣 READ CAREFULLY BEFORE CREATING THIS PR 📣
+1️⃣ This PR template is exclusively for HOTFIX
+2️⃣ The PR title must start from "hotfix:"
+3️⃣ The PR title must be written in lowercase
+4️⃣ The topic must be provided with requested below information
+-->
+
+## Standards checklist:
+- [ ] The PR title is descriptive
+- [ ] There is no PR that addresses this issue
+- [ ] The PR has self-explained commits history
+- [ ] The code is mine or has Apache-2.0 compatible license
+- [ ] The code is efficient enough, it respects user resources
+- [ ] The code is stable and tested
+- [ ] There is new functionality, information is provided below
+
+## Changes:
+...
+
+## Other comments:
+...
diff --git a/.github/PULL_REQUEST_TEMPLATE/MAINTENANCE.md b/.github/PULL_REQUEST_TEMPLATE/MAINTENANCE.md
new file mode 100644
index 0000000000..ce228b07ef
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/MAINTENANCE.md
@@ -0,0 +1,20 @@
+<!--
+📣 READ CAREFULLY BEFORE CREATING THIS PR 📣
+1️⃣ This PR template is exclusively for REPOSITORY MAINTENANCE
+2️⃣ The PR title must start from "repo:"
+3️⃣ The PR title must be written in lowercase
+4️⃣ If PR changes workflow, test it before pushing
+5️⃣ The topic must be provided with requested below information
+-->
+
+## Standards checklist:
+- [ ] The PR title is descriptive
+- [ ] There is no PR that addresses this issue
+- [ ] The PR has self-explained commits history
+- [ ] The workflow changes are tested, results are provided below
+
+## Changes:
+...
+
+## Other comments:
+...
diff --git a/.github/PULL_REQUEST_TEMPLATE/PATCH.md b/.github/PULL_REQUEST_TEMPLATE/PATCH.md
new file mode 100644
index 0000000000..9b0df56677
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/PATCH.md
@@ -0,0 +1,22 @@
+<!--
+📣 READ CAREFULLY BEFORE CREATING THIS PR 📣
+1️⃣ This PR template is exclusively for PATCH
+2️⃣ The PR title must start from "patch:"
+3️⃣ The PR title must be written in lowercase
+4️⃣ The topic must be provided with requested below information
+-->
+
+## Standards checklist:
+- [ ] The PR title is descriptive
+- [ ] There is no PR that addresses this issue
+- [ ] The PR has self-explained commits history
+- [ ] The code is mine or has Apache-2.0 compatible license
+- [ ] The code is efficient enough, it respects user resources
+- [ ] The code is stable and tested
+- [ ] There is new functionality, information is provided below
+
+## Changes:
+...
+
+## Other comments:
+...
diff --git a/.github/PULL_REQUEST_TEMPLATE/REFACTORING.md b/.github/PULL_REQUEST_TEMPLATE/REFACTORING.md
new file mode 100644
index 0000000000..58059a5153
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/REFACTORING.md
@@ -0,0 +1,19 @@
+<!--
+📣 READ CAREFULLY BEFORE CREATING THIS PR 📣
+1️⃣ This PR template is exclusively for REFACTORING
+2️⃣ The PR title must start from "refactor:"
+3️⃣ The PR title must be written in lowercase
+4️⃣ The topic must be provided with requested below information
+-->
+
+## Standards checklist:
+- [ ] The PR title is descriptive
+- [ ] There is no PR that addresses this issue
+- [ ] The PR has self-explained commits history
+- [ ] The workflow changes are tested, results are provided below
+
+## Changes:
+...
+
+## Other comments:
+...