Pull Request (PR) Template

Click to view Sample PR

Markdown Preview

Reference (if applicable)

• This PR addresses [brief description of what the PR fixes or adds]
• Related to Issue #__ or Original PR #__

---

Problem

• Briefly describe the issues or limitations this PR solves

  Example:

  • The form submission didn’t trigger a page redirect
  • UI did not update after adding a new student record

---

Approach

• Summarize key code changes and which files were affected (modified/created)

• List any new API routes, endpoints, or significant logic changes (if applicable)

  Example:

  • FormComponent.vue:
    • Updated event handler to use X
  • StudentList.vue:
    • Added watcher to refresh Y on data change
  • NewComponent.vue:
    • Created new, reusable component to better manage Z
    • Defined custom props: A (String), B (Boolean), C (Integer)
  • New Routes or Functionalities:
    • Added GET /api/____ endpoint to fetch ____

---

Testing Details (if applicable)

• Describe how changes were tested and expected outcomes

  Example:

  • Manually tested form submission on Chrome and Firefox
  • Verified user count updates correctly on dashboard
  • Confirmed no errors in console during navigation

---

Demos (if applicable)

Before

• (Caption): Previously, ____.

After

• (Caption): Now, ______.

---

Minor Enhancements (if applicable)

Example:

• Fixed typo in button label
• Updated placeholder text for clarity

---

Notes / Future Improvements (if applicable)

Example:

• Will need to test on Safari
• Can extend this logic later to support other user roles

---

Click to view, copy, and paste/edit code for above PR template

Markdown Code

## Reference (if applicable)
- This PR addresses [brief description of what the PR fixes or adds]  
- Related to [Issue #__](url) or [Original PR #__](url)

---

## Problem
- Briefly describe the issues or limitations this PR solves

  _Example:_  
  - The form submission didn’t trigger a page redirect  
  - UI did not update after adding a new student record  

---

## Approach
- Summarize key code changes and which files were affected (modified/created)  
- List any new API routes, endpoints, or significant logic changes (if applicable)

  _Example:_  
  - **`FormComponent.vue`:** 
    - Updated event handler to use X  
  - **`StudentList.vue`:** 
    - Added watcher to refresh Y on data change  
  - **`NewComponent.vue`:** 
    - Created new, reusable component to better manage Z
    - Defined custom props: A (`String`), B (`Boolean`), C (`Integer`)  
  - **New Routes or Functionalities:** 
    - Added `GET /api/____` endpoint to fetch ____

---

## Testing Details (if applicable)
- Describe how changes were tested and expected outcomes

  _Example:_  
  - Manually tested form submission on Chrome and Firefox  
  - Verified user count updates correctly on dashboard  
  - Confirmed no errors in console during navigation  

---

## Demos (if applicable)

### Before
- (Caption): Previously, ____.

<img src="url" width="300" alt="Before screenshots">

### After
- (Caption): Now, ______.

<img src="url" width="300" alt="After screenshots">

---

## Minor Enhancements (if applicable)

  _Example:_  
  - Fixed typo in button label  
  - Updated placeholder text for clarity  

---

## Notes / Future Improvements (if applicable)

  _Example:_  
  - Will need to test on Safari  
  - Can extend this logic later to support other user roles