From 544179e2dcf2ede0682db822d48db77c414344dd Mon Sep 17 00:00:00 2001
From: Artin <clxune09@gmail.com>
Date: Sun, 15 Sep 2024 17:06:36 +0330
Subject: [PATCH 1/3] chore(template): improve PullRequest template

- Added sections for clear description including summary, problem, solution, and impact.
- Updated Helpful Resources section with links to contributing guides, Git practices, and community standards.
---
 .github/PULL_REQUEST_TEMPLATE.md | 62 +++++++++++++++++++++++++-------
 1 file changed, 50 insertions(+), 12 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 86c88966..edb601b4 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,21 +1,59 @@
-### Prerequisites
+## Prerequisites
 
-- [ ] I have read and understood the [contributing guide][CONTRIBUTING.md].
-- [ ] The commit message follows the [conventional commits][cc] guidelines.
-- [ ] Tests for the changes have been added (for bug fixes / features).
-- [ ] Docs have been added/updated (for bug fixes / features).
+- [ ] I have read and understood the [Contributing Guide][contributing].
+- [ ] My commit message follows the [Conventional Commits][cc] guidelines.
+- [ ] Relevant tests have been added or updated (for bug fixes/features).
+- [ ] Documentation has been added or updated (for bug fixes/features).
 
-### Description
+## Description
 
-<!---
+<!--
+**Description of Changes:**
 
-Tips:
+Please provide a clear and concise description of the changes introduced by this pull request. You should explain the following:
 
-If you're not comfortable with working with Git,
-we're working a guide (https://ohmyposh.dev/docs/contributing/git) to help you out.
-Oh My Posh advises GitKraken (https://www.gitkraken.com/invite/nQmDPR9D) as your preferred cross platform Git GUI power tool.
+1. **Summary:** Briefly describe the main change or addition in this PR. What is the overall purpose of your changes?
+2. **Problem:** Specify the issue or problem this PR addresses. Include any relevant context or background to explain why this change is necessary.
+3. **Solution:** Explain how your changes resolve the issue or add the new feature. Provide key implementation details to clarify how the solution works.
+4. **Impact:** Note any potential impacts or side effects of your changes. Mention if additional testing is needed or if there are any known limitations.
+
+**Example:**
+"This PR introduces a new feature for X by implementing Y. This change addresses the issue reported in #123 by [explain how it fixes the problem].
+Closes #123"
+
+Please ensure that each section is thoroughly explained to assist reviewers in understanding your changes.
 
 -->
 
-[CONTRIBUTING.md]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/CONTRIBUTING.md
+<!-- Description of your changes: -->
+
+
+<br>
+<br>
+<br>
+
+---
+
+### Helpful Resources
+
+- **[Getting Started Guide][started-guide]:** For first-time contributors, this guide will help you get acquainted with the project.
+- **[OhMyPosh Git Guide][git-guide]:** For understanding Git practices and commands.
+- **[Discussions Page][discussions]:** Join project discussions and ask questions.
+- **[GitKraken Guide][gitkraken]:** Recommended tool for managing Git repositories.
+<!-- - **[Code Structure Guide][code-structure]:** Understand the overall organization of our codebase. -->
+
+- **[Community Standard][community]:** Engage with the community and understand our community standards.
+- **[Contributing Guide][contributing]:** Read and understand our guidelines for contributing.
+- **[GitHub’s Pull Request Review Guide][gh-pr-review]:** Additional guidance on the review process.
+<!-- - **[Pitfalls to Avoid][pitfalls]:** Common mistakes to watch out for when contributing. -->
+
+
+
+[contributing]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/CONTRIBUTING.md
 [cc]: https://www.conventionalcommits.org/en/v1.0.0/#summary
+[started-guide]: https://ohmyposh.dev/docs/contributing/started
+[git-guide]: https://ohmyposh.dev/docs/contributing/git
+[discussions]: https://github.com/JanDeDobbeleer/oh-my-posh/discussions
+[gitkraken]: https://www.gitkraken.com/invite/nQmDPR9D
+[community]: https://github.com/JanDeDobbeleer/oh-my-posh/community
+[gh-pr-review]: https://help.github.com/en/articles/about-pull-request-reviews

From a2845ef6fbc0bda5b4c023add6f960866ebd2d88 Mon Sep 17 00:00:00 2001
From: Artin <clxune09@gmail.com>
Date: Sun, 15 Sep 2024 22:11:32 +0330
Subject: [PATCH 2/3] style(template): refine PullRequest template for clarity

Co-authored-by: L. Yeung <lewis-yeung@foxmail.com>
---
 .github/PULL_REQUEST_TEMPLATE.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index edb601b4..5726d8db 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,8 +2,8 @@
 
 - [ ] I have read and understood the [Contributing Guide][contributing].
 - [ ] My commit message follows the [Conventional Commits][cc] guidelines.
-- [ ] Relevant tests have been added or updated (for bug fixes/features).
-- [ ] Documentation has been added or updated (for bug fixes/features).
+- [ ] Relevant tests have been added or updated (for bug fixes or features).
+- [ ] Documentation has been added or updated (for bug fixes or features).
 
 ## Description
 

From 05e491b641baeda3c0d5d41d3ed99d9efac85328 Mon Sep 17 00:00:00 2001
From: Artin <clxune09@gmail.com>
Date: Thu, 19 Sep 2024 21:38:56 +0330
Subject: [PATCH 3/3] chore(template): update PullRequest template

1. **Commitlint Rules:** Added a reference to commitlint rules and standards to ensure that commit messages follow guidelines.
2. **Extended Description:** Expanded the description section to include an additional point for indicating which issues the PR resolves or closes.

These updates aim to enhance clarity and ensure that pull requests adhere to our contribution and commit message standards.
---
 .github/PULL_REQUEST_TEMPLATE.md | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5726d8db..7ed448b9 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,13 +1,14 @@
 ## Prerequisites
 
 - [ ] I have read and understood the [Contributing Guide][contributing].
-- [ ] My commit message follows the [Conventional Commits][cc] guidelines.
+- [ ] My commit messages follow the [Conventional Commits][cc] guidelines and our [commitlint rules and standards][commitlint].
 - [ ] Relevant tests have been added or updated (for bug fixes or features).
-- [ ] Documentation has been added or updated (for bug fixes or features).
+- [ ] Documentations have been added or updated (for bug fixes or features).
 
 ## Description
 
 <!--
+
 **Description of Changes:**
 
 Please provide a clear and concise description of the changes introduced by this pull request. You should explain the following:
@@ -16,18 +17,29 @@ Please provide a clear and concise description of the changes introduced by this
 2. **Problem:** Specify the issue or problem this PR addresses. Include any relevant context or background to explain why this change is necessary.
 3. **Solution:** Explain how your changes resolve the issue or add the new feature. Provide key implementation details to clarify how the solution works.
 4. **Impact:** Note any potential impacts or side effects of your changes. Mention if additional testing is needed or if there are any known limitations.
+5. **Issue Closure:** Indicate which issues this PR resolves or closes.
 
 **Example:**
-"This PR introduces a new feature for X by implementing Y. This change addresses the issue reported in #123 by [explain how it fixes the problem].
+"This PR introduces a new feature for X by implementing Y that will optimize the query logic, which reduces execution time and prevents the error. This change addresses the issue reported in #123.
+
 Closes #123"
 
 Please ensure that each section is thoroughly explained to assist reviewers in understanding your changes.
 
 -->
 
-<!-- Description of your changes: -->
+---
+
+<br>
+<br>
+<br>
 
 
+<!-- _Description of your changes:_ -->
+
+
+
+<br>
 <br>
 <br>
 <br>
@@ -37,7 +49,7 @@ Please ensure that each section is thoroughly explained to assist reviewers in u
 ### Helpful Resources
 
 - **[Getting Started Guide][started-guide]:** For first-time contributors, this guide will help you get acquainted with the project.
-- **[OhMyPosh Git Guide][git-guide]:** For understanding Git practices and commands.
+- **[Oh My Posh Git Guide][git-guide]:** For understanding Git practices and commands.
 - **[Discussions Page][discussions]:** Join project discussions and ask questions.
 - **[GitKraken Guide][gitkraken]:** Recommended tool for managing Git repositories.
 <!-- - **[Code Structure Guide][code-structure]:** Understand the overall organization of our codebase. -->
@@ -51,6 +63,7 @@ Please ensure that each section is thoroughly explained to assist reviewers in u
 
 [contributing]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/CONTRIBUTING.md
 [cc]: https://www.conventionalcommits.org/en/v1.0.0/#summary
+[commitlint]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/.commitlintrc.yml
 [started-guide]: https://ohmyposh.dev/docs/contributing/started
 [git-guide]: https://ohmyposh.dev/docs/contributing/git
 [discussions]: https://github.com/JanDeDobbeleer/oh-my-posh/discussions