Update README.md

more edits

Author: maymahmoud84

README.md

@@ -85,6 +85,8 @@ This means each pair will have **two repositories** - one per person.
 
 ## Exercise Instructions
 
+> **Note:** A checklist is provided at the end of this document to help you track your progress and ensure you complete all exercise steps.
+
 ### Step 1: Set Up Your Repository
 
 **Each partner** creates their own repository from this template:
@@ -297,102 +299,62 @@ After receiving review feedback on **your own repository**:
 
 After your feature is merged, create a Python script to extract PR information from your repository.
 
-**Your Task:** Research the GitHub REST API and write a script called `mine_prs.py` that supports two modes:
-
-**Mode 1: List All PRs**
+**Your Task:** Research ways to mine a GitHub repo and write a script called `mine_prs.py` that:
 
 - Accepts repository owner and name as command-line arguments
 - Fetches all Pull Requests from the repository
-- Displays summary information for each PR
-
-**Mode 2: Get Commits for a Specific PR**
-
-- Accepts repository owner, name, and PR number as command-line arguments
-- Retrieves and displays all commits associated with that specific PR
+- For each PR, retrieves and displays all associated commits
 
 **Requirements:**
 
 - [ ] Accepts repository owner and name as command-line arguments
-- [ ] Optionally accepts a PR number to get commits for a specific PR
-- [ ] When no PR number is provided: lists all PRs with summary info
-- [ ] When PR number is provided: retrieves commits for that specific PR
+- [ ] Fetches all PRs from the repository
+- [ ] For each PR, retrieves its associated commits
 - [ ] Displays information in a clear, formatted output
 
 **Information to Display:**
 
-For listing all PRs:
+For each PR:
 
 - PR number and title
 - PR state (open/closed/merged)
 - PR author
 - Creation date
-
-For a specific PR's commits:
-
-- PR number and title
-- Each commit's SHA (short format)
-- Commit message
-- Commit author
-- Commit date
+- List of commits with:
+  - Commit SHA (short format)
+  - Commit message
+  - Commit author
 
 **Suggested Output Format:**
 
 ```
-# Mode 1: List all PRs
-$ python mine_prs.py owner repo
+$ python mine_prs.py your-username collabdev-exercise-username
 
 ============================================================
-PULL REQUESTS FOR owner/repo
+PULL REQUESTS FOR your-username/collabdev-exercise-username
 ============================================================
 
-PR #2: Add product categories
-  State:   merged
-  Author:  partner-username
-  Created: 2024-01-15T10:30:00Z
-
 PR #1: Add low-stock alert functionality
   State:   merged
   Author:  your-username
   Created: 2024-01-15T09:00:00Z
+  Commits:
+    - abc1234: Add is_low_stock method to Product class (Your Name)
+    - def5678: Add get_low_stock_products function (Your Name)
+    - ghi9012: Add unit tests for low stock functionality (Your Name)
 
 ------------------------------------------------------------
-Total PRs: 2
-============================================================
-```
-
-```
-# Mode 2: Get commits for specific PR
-$ python mine_prs.py owner repo 1
-
-============================================================
-COMMITS FOR PR #1: Add low-stock alert functionality
-============================================================
-
-  abc1234 - Add is_low_stock method to Product class
-            Author: Your Name
-            Date:   2024-01-15T09:15:00Z
-
-  def5678 - Add get_low_stock_products function
-            Author: Your Name
-            Date:   2024-01-15T09:30:00Z
-
-  ghi9012 - Add unit tests for low stock functionality
-            Author: Your Name
-            Date:   2024-01-15T09:45:00Z
-
-------------------------------------------------------------
-Total commits: 3
+Total PRs: 1
 ============================================================
 ```
 
 **Hints:**
 
-- Use a GitHub library like `PyGithub` to interact with the GitHub API
+- You can use a GitHub library like `PyGithub` or '`PyDriller` to interact with the GitHub API
 - Use `sys.argv` or `argparse` to handle command-line arguments
 - Use `python-dotenv` to load environment variables from a `.env` file
 - GitHub API endpoint for PRs: `https://api.github.com/repos/{owner}/{repo}/pulls`
 - GitHub API endpoint for PR commits: `https://api.github.com/repos/{owner}/{repo}/pulls/{pr_number}/commits`
-- Use `state=all` parameter to get both open and closed PRs
 
 **GitHub Token Setup:**
 
@@ -410,64 +372,18 @@ Total commits: 3
 
 7. **Important:** Add `.env` to your `.gitignore` to keep your token secure!
 
-8. **Add dependencies to `requirements.txt`:**
-   ```
-   pytest==8.0.0
-   PyGithub
-   python-dotenv
-   ```
+8. \*\*Add dependencies to `requirements.txt`
 
 **Run your script:**
 
 ```bash
 pip install -r requirements.txt
 
-# List all PRs
 python mine_prs.py <owner> <repo>
-
-# Get commits for a specific PR
-python mine_prs.py <owner> <repo> <pr_number>
 ```
 
 ---
 
-## Exercise Checklist
-
-### Your Repository
-
-- [ ] Created your own repository from template (using "Use this template" button)
-- [ ] Added your partner as a collaborator
-- [ ] Created an Issue for your assigned feature
-- [ ] Created a feature branch
-- [ ] Implemented the feature with tests
-- [ ] Created a Pull Request linked to the Issue
-- [ ] Added your partner as a reviewer on your PR
-- [ ] Addressed review feedback (if any)
-- [ ] CI passes on your PR
-- [ ] PR merged to main
-
-### Partner's Repository
-
-- [ ] Accepted collaborator invitation
-- [ ] Reviewed your partner's Pull Request
-- [ ] Left constructive comments on the code
-- [ ] Submitted review (approved or requested changes)
-
-### PR Mining Script
-
-- [ ] Created a GitHub Personal Access Token
-- [ ] Set up `.env` file with token (and added `.env` to `.gitignore`)
-- [ ] Added dependencies (PyGithub, python-dotenv) to `requirements.txt`
-- [ ] Researched GitHub REST API or PyGithub documentation
-- [ ] Created `mine_prs.py` script
-- [ ] Script supports Mode 1: List all PRs with summary info
-- [ ] Script supports Mode 2: Get commits for a specific PR number
-- [ ] Script accepts command-line arguments (owner, repo, optional PR number)
-- [ ] Output is clearly formatted and readable
-- [ ] Successfully executed script on your repository
-
----
-
 ## Submission Instructions
 
 Submit the following evidence of your work to **Brightspace**:
@@ -506,9 +422,8 @@ Submit the following evidence of your work to **Brightspace**:
 6. **PR Mining Script Code and Output**
 
    - Submit your `mine_prs.py` file
-   - Include screenshots showing both modes of the script:
-     - Mode 1 output: List of all PRs in your repository
-     - Mode 2 output: Commits for your specific PR
+   - Include a screenshot showing the script output:
+     - List of all PRs in your repository with their associated commits
 
 7. **Updated `requirements.txt` file**
 
@@ -551,6 +466,46 @@ By completing this exercise, you will have practiced:
 - [GitHub REST API - List commits on a PR](https://docs.github.com/en/rest/pulls/pulls#list-commits-on-a-pull-request)
 - [PyGithub Documentation](https://pygithub.readthedocs.io/)
 - [PyGithub GitHub Repository](https://github.com/PyGithub/PyGithub)
+- [PyDriller Documentation](https://pydriller.readthedocs.io/)
+- [PyDriller GitHub Repository](https://github.com/ishepard/pydriller)
+
+---
+
+## Exercise Checklist
+
+Use this checklist to track your progress and ensure you complete all exercise steps.
+
+### Your Repository
+
+- [ ] Created your own repository from template (using "Use this template" button)
+- [ ] Added your partner as a collaborator
+- [ ] Created an Issue for your assigned feature
+- [ ] Created a feature branch
+- [ ] Implemented the feature with tests
+- [ ] Created a Pull Request linked to the Issue
+- [ ] Added your partner as a reviewer on your PR
+- [ ] Addressed review feedback (if any)
+- [ ] CI passes on your PR
+- [ ] PR merged to main
+
+### Partner's Repository
+
+- [ ] Accepted collaborator invitation
+- [ ] Reviewed your partner's Pull Request
+- [ ] Left constructive comments on the code
+- [ ] Submitted review (approved or requested changes)
+
+### PR Mining Script
+
+- [ ] Created a GitHub Personal Access Token
+- [ ] Set up `.env` file with token (and added `.env` to `.gitignore`)
+- [ ] Added dependencies to `requirements.txt`
+- [ ] Researched GitHub REST API, PyGithub, or PyDriller documentation
+- [ ] Created `mine_prs.py` script
+- [ ] Script lists all PRs with their associated commits
+- [ ] Script accepts command-line arguments (owner, repo)
+- [ ] Output is clearly formatted and readable
+- [ ] Successfully executed script on your repository
 
 ---