From 8d0895e82f0f300eba0e8a31c7e6ef04c4990214 Mon Sep 17 00:00:00 2001
From: husnain <52630357+husnain067@users.noreply.github.com>
Date: Fri, 30 May 2025 05:47:46 +0500
Subject: [PATCH 1/6] update the PR template and instrcutions

---
 .github/pull_request_template.md | 93 ++++++++++++++------------------
 1 file changed, 39 insertions(+), 54 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 75b7f2d7..81a5209e 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,63 +1,68 @@
 # Feature Pull Request
 
 ## Branch Naming Convention
-<!-- IMPORTANT: Your branch should follow our naming convention -->
-<!-- Format: feature/short-description-of-feature or feature/issue-number-description -->
-<!-- Example: feature/user-authentication or feature/123-user-auth -->
+<!-- Use branch names like: feature/description or feature/123-description (e.g., feature/user-authentication or feature/123-user-auth) -->
 Current branch: `<!-- Replace with your branch name -->`
 
 ## Related Issue
-<!-- IMPORTANT: Please verify this issue number is correct and exists -->
-<!-- Use the format: Closes #123 or Fixes #123 to automatically close the issue when this PR is merged -->
+<!-- IMPORTANT: Please verify this issue number is correct and exists to automatically close the issue when this PR is merged -->
+<!-- Link to the issue using format: Closes #123 or Fixes #123 -->
 Closes #
 
 ## Feature Description
 <!-- Provide a clear and concise description of the feature being implemented -->
-<!-- Example: This PR adds user authentication via OAuth2 with GitHub provider, allowing users to log in with their GitHub accounts. This includes the login flow, user profile creation, and session management. -->
+<!-- Example: Adds user authentication via OAuth2, including login flow and profile creation -->
 
 ## Implementation Details
 <!-- Provide a technical overview of how the feature was implemented -->
 <!-- Include architectural decisions and design patterns used -->
 <!-- Example:
-- Implemented using the Strategy pattern to allow for multiple auth providers in the future
-- Used JWT for session management with a 24-hour expiration
-- Created a middleware layer to handle authentication checks
+- Used Strategy pattern for multiple auth providers
+- Middleware for authentication checks
+-->
+
+<!-- Note:
+Mention any CI/CD failing checks unrelated to this PR
+Any TODO items pending
 -->
 
 ## Changes Made
-<!-- List the significant changes made to implement this feature -->
+<!-- List key changes made for this feature -->
 <!-- Example:
-- Added AuthService class to handle authentication flow
-- Created new database migrations for user table
-- Updated configuration to support OAuth settings
-- Added middleware for authenticated routes
-- Created login/logout endpoints
+- Added AuthService class to handle authentication
+- Created user table migrations
 -->
 -
 -
--
 
 ## Testing Performed
-<!-- Describe the testing you've done to validate the feature -->
-<!-- Include both automated and manual testing -->
+<!-- Describe the testing you've done both automated and manual to validate the feature -->
 <!-- Example:
-- Added unit tests for AuthService with 95% coverage
-- Added integration tests for authentication flow
-- Manually tested login flow on Chrome, Firefox, and Safari
-- Verified error handling for invalid credentials
+- Manually tested pre-commit passing on all files
+- Verified newly added workflows pass in CI/CD
+- Tested any new tool/command added
 -->
 
-## Pre-commit and Testing Instructions
-<!-- Follow these steps to run pre-commit hooks and tests before submitting -->
+## Testing Instructions
+<!-- Follow these steps to run and test before submitting -->
+
+**Install new dependencies or tools (if applicable):**
+If this PR adds new dependencies or tools, install them using the project’s recommended method (Justfile):
 
-**Running Pre-commit Hooks:**
 ```bash
-# These are basic defaults for testing.
-# Please adjust as needed for complete testing of your changes
+# Example installation command (replace with the actual one)
+just install-[tool-name]
+```
+## Verify the installation new dependencies or tools (if applicable):**
+
 
-# Install pre-commit if not already installed
-just pre-commit-setup
+```bash
+# Confirm the tool or dependency is installed and available:
+[tool-name] --version
+```
 
+**Running Pre-commit Hooks:**
+```bash
 # Run pre-commit on all files
 just pre-commit-run
 ```
@@ -73,38 +78,18 @@ just test
 -->
 
 ## Documentation Updates
-<!-- Describe any documentation changes made or needed -->
-<!-- Include updates to Sphinx docs, README, etc. -->
+<!-- List any documentation changes made or needed -->
 <!-- Example:
-- Updated authentication section in docs/usage.md
-- Added new docs/auth.md file with detailed API documentation
-- Updated README.md with new authentication instructions
-- Added docstrings to all new classes and methods
+- Added new docs/auth.md
+- Updated README.md
+- Added docstrings to new classes/methods
 -->
 
-## Breaking Changes
-<!-- List any backwards-incompatible changes this PR introduces -->
-<!-- If none, state "None" -->
-<!-- Example: The config format has changed, existing config files need to be updated following the migration guide in docs/migrations.md -->
-
 ## Checklist
 <!-- Please verify each item by checking the box -->
-- [ ] Branch name follows convention (`feature/description` or `feature/issue-number-description`)
 - [ ] Testing added to pre-commit hook (`pre-commit run --all-files` passes)
-- [ ] Testing added to CI/CD pipeline in GitHub Actions
+- [ ] All tests pass locally and in CI
 - [ ] Documentation added/updated in Sphinx
 - [ ] Appropriate unit test coverage added (run `pytest --cov` to verify)
-- [ ] New commands added to CLI (if applicable)
-- [ ] Code follows project style guidelines (`flake8` or equivalent passes)
-- [ ] All tests pass locally and in CI
 - [ ] Self-review of code performed
 - [ ] No debug print statements or commented-out code left in the codebase
-
-## Reviewer Notes
-<!-- Any specific areas that need careful review or explanation -->
-<!-- Highlight complex parts or areas where you're seeking feedback -->
-<!-- Example:
-- The authentication flow in auth_service.py:125-150 is complex and needs careful review
-- The database migration might need performance review for large datasets
-- Security review needed for the token generation logic
--->

From 6066c1f8e800328ddf089f4e8e9ffacf8a1ee1bc Mon Sep 17 00:00:00 2001
From: husnain <52630357+husnain067@users.noreply.github.com>
Date: Sat, 31 May 2025 00:53:13 +0500
Subject: [PATCH 2/6] update the changes in testing instructions

---
 .github/pull_request_template.md | 54 +++++++++++++++++---------------
 1 file changed, 28 insertions(+), 26 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 81a5209e..5f1de062 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -2,12 +2,12 @@
 
 ## Branch Naming Convention
 <!-- Use branch names like: feature/description or feature/123-description (e.g., feature/user-authentication or feature/123-user-auth) -->
-Current branch: `<!-- Replace with your branch name -->`
+Current branch: `<Replace with your branch name>`
 
 ## Related Issue
 <!-- IMPORTANT: Please verify this issue number is correct and exists to automatically close the issue when this PR is merged -->
 <!-- Link to the issue using format: Closes #123 or Fixes #123 -->
-Closes #
+Closes #issue-number
 
 ## Feature Description
 <!-- Provide a clear and concise description of the feature being implemented -->
@@ -21,9 +21,9 @@ Closes #
 - Middleware for authentication checks
 -->
 
-<!-- Note:
-Mention any CI/CD failing checks unrelated to this PR
-Any TODO items pending
+**Important Notes (please address or acknowledge):**
+- Mention any CI/CD failing checks unrelated to this PR**
+- List any TODO items that are still pending**
 -->
 
 ## Changes Made
@@ -42,38 +42,39 @@ Any TODO items pending
 - Verified newly added workflows pass in CI/CD
 - Tested any new tool/command added
 -->
+-
+-
 
 ## Testing Instructions
 <!-- Follow these steps to run and test before submitting -->
 
-**Install new dependencies or tools (if applicable):**
-If this PR adds new dependencies or tools, install them using the project’s recommended method (Justfile):
+**Common Testing Instructions**
 
-```bash
-# Example installation command (replace with the actual one)
-just install-[tool-name]
-```
-## Verify the installation new dependencies or tools (if applicable):**
+To ensure code quality and consistency before submitting:
 
+**Run pre-commit checks on all files**
 
-```bash
-# Confirm the tool or dependency is installed and available:
-[tool-name] --version
-```
+```just pre-commit-run```
 
-**Running Pre-commit Hooks:**
-```bash
-# Run pre-commit on all files
-just pre-commit-run
-```
+**Run all tests (Note: The `just test` command is a project-specific test runner.)**
+
+```just test```
+
+**Install the package in editable mode with development dependencies**
+
+```just install-dev```
+
+**Install new dependencies or tools (if added):**
+
+If this PR adds new dependencies or tools, install them using the project’s recommended method (Justfile):
 
-**Running Tests:**
 ```bash
-# Run all tests
-just test
-# Note: The `just test` command is a project-specific command for running tests.
-# Please refer to the project documentation or the CONTRIBUTING.md file for setup instructions.
+# Example installation command (replace with the actual one)
+just install-[tool-name]
 ```
+**Testing just commands for new dependencies or tools (if added):**
+- ```just A``` # To test the A functionality
+- ```just B``` # To test the B functionality
 
 -->
 
@@ -84,6 +85,7 @@ just test
 - Updated README.md
 - Added docstrings to new classes/methods
 -->
+-
 
 ## Checklist
 <!-- Please verify each item by checking the box -->

From ff140ae882de722dbbaebce6b202affe50f40759 Mon Sep 17 00:00:00 2001
From: husnain <52630357+husnain067@users.noreply.github.com>
Date: Sat, 31 May 2025 00:55:32 +0500
Subject: [PATCH 3/6] update the format

---
 .github/pull_request_template.md | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 5f1de062..15c67c12 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -22,9 +22,8 @@ Closes #issue-number
 -->
 
 **Important Notes (please address or acknowledge):**
-- Mention any CI/CD failing checks unrelated to this PR**
-- List any TODO items that are still pending**
--->
+- Mention any CI/CD failing checks unrelated to this PR
+- List any TODO items that are still pending
 
 ## Changes Made
 <!-- List key changes made for this feature -->

From 49f7f35539c90f9497332234d63ed981b7620132 Mon Sep 17 00:00:00 2001
From: husnain <52630357+husnain067@users.noreply.github.com>
Date: Sat, 31 May 2025 01:11:32 +0500
Subject: [PATCH 4/6] update the testing instructions with more commands

---
 .github/pull_request_template.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 15c67c12..2e241a07 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -51,6 +51,10 @@ Closes #issue-number
 
 To ensure code quality and consistency before submitting:
 
+**Install the package in editable mode with development dependencies**
+
+```just install-dev```
+
 **Run pre-commit checks on all files**
 
 ```just pre-commit-run```
@@ -59,9 +63,13 @@ To ensure code quality and consistency before submitting:
 
 ```just test```
 
-**Install the package in editable mode with development dependencies**
+**To run linting checks**
 
-```just install-dev```
+```just lint```
+
+ **To run code formatting**
+
+```just format```
 
 **Install new dependencies or tools (if added):**
 

From c41943320009d4bc785bc09cc960467529a3383e Mon Sep 17 00:00:00 2001
From: Steve Morin <steve.morin@gmail.com>
Date: Fri, 30 May 2025 15:15:50 -0700
Subject: [PATCH 5/6] Update pull_request_template.md

---
 .github/pull_request_template.md | 16 +++++-----------
 1 file changed, 5 insertions(+), 11 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 2e241a07..53230931 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -2,16 +2,14 @@
 
 ## Branch Naming Convention
 <!-- Use branch names like: feature/description or feature/123-description (e.g., feature/user-authentication or feature/123-user-auth) -->
-Current branch: `<Replace with your branch name>`
+Current branch: [BRANCH_NAME]
 
 ## Related Issue
 <!-- IMPORTANT: Please verify this issue number is correct and exists to automatically close the issue when this PR is merged -->
-<!-- Link to the issue using format: Closes #123 or Fixes #123 -->
-Closes #issue-number
+Closes #ISSUE_NUMBER
 
 ## Feature Description
 <!-- Provide a clear and concise description of the feature being implemented -->
-<!-- Example: Adds user authentication via OAuth2, including login flow and profile creation -->
 
 ## Implementation Details
 <!-- Provide a technical overview of how the feature was implemented -->
@@ -22,8 +20,10 @@ Closes #issue-number
 -->
 
 **Important Notes (please address or acknowledge):**
+<!--
 - Mention any CI/CD failing checks unrelated to this PR
-- List any TODO items that are still pending
+- List any TODO items that are still pending and not closed by this PR
+-->
 
 ## Changes Made
 <!-- List key changes made for this feature -->
@@ -31,8 +31,6 @@ Closes #issue-number
 - Added AuthService class to handle authentication
 - Created user table migrations
 -->
--
--
 
 ## Testing Performed
 <!-- Describe the testing you've done both automated and manual to validate the feature -->
@@ -41,8 +39,6 @@ Closes #issue-number
 - Verified newly added workflows pass in CI/CD
 - Tested any new tool/command added
 -->
--
--
 
 ## Testing Instructions
 <!-- Follow these steps to run and test before submitting -->
@@ -83,8 +79,6 @@ just install-[tool-name]
 - ```just A``` # To test the A functionality
 - ```just B``` # To test the B functionality
 
--->
-
 ## Documentation Updates
 <!-- List any documentation changes made or needed -->
 <!-- Example:

From 44f58bae1723f1f509d38be55e1439ed64a014b8 Mon Sep 17 00:00:00 2001
From: Steve Morin <steve.morin@gmail.com>
Date: Fri, 30 May 2025 15:16:27 -0700
Subject: [PATCH 6/6] Update pull_request_template.md

removed brackets so double click selects the whole name/word
---
 .github/pull_request_template.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 53230931..8200f50c 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -2,7 +2,7 @@
 
 ## Branch Naming Convention
 <!-- Use branch names like: feature/description or feature/123-description (e.g., feature/user-authentication or feature/123-user-auth) -->
-Current branch: [BRANCH_NAME]
+Current branch: BRANCH_NAME
 
 ## Related Issue
 <!-- IMPORTANT: Please verify this issue number is correct and exists to automatically close the issue when this PR is merged -->