Merge branch 'main' into redesign-ui

Author: steam-bell-92

.github/workflows/python-ci.yml

@@ -0,0 +1,31 @@
+name: Python CI Pipeline
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        
+    - name: Syntax check with py_compile
+      run: |
+        find . -name "*.py" -exec python -m py_compile {} +
+        
+    - name: Run automated tests
+      run: |
+        python -m unittest discover -s tests -v

CONTRIBUTING.md

@@ -447,6 +447,27 @@ These tasks are beginner-friendly and help you understand the project structure,
 
 Once you feel comfortable, you can gradually try `level:intermediate`, `level:advanced`, and `level:critical` tasks.
 
+## 🧪 Writing Tests
+
+To maintain code quality and ensure zero external dependencies, we use the standard library's `unittest` framework.
+
+1. **Test Directory**: All tests must be placed in the `tests/` directory at the root of the project.
+2. **File Naming**: Name your test file starting with `test_` (e.g., `test_armstrong.py`).
+3. **No External Modules**: Do not use external libraries like `pytest`. Stick strictly to `unittest`.
+4. **Mocking Inputs**: For CLI projects, use `subprocess` to provide input via `stdin`, or import helper methods directly.
+
+### Running Tests Locally
+To run all tests and verify your changes:
+```bash
+python -m unittest discover -s tests -v
+```
+To run a syntax check across all files (similar to our CI):
+```bash
+find . -name "*.py" -exec python -m py_compile {} +
+```
+
+---
+
 ## 🤔 Questions?
 
 - 💬 Open an issue for questions

README.md

@@ -504,6 +504,12 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
     </td>
   </tr>
   <tr>
+    <td align="center" width="120">
+      <a href="https://github.com/bhavyapandiya29">
+        <img src="https://github.com/bhavyapandiya29.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="bhavyapandiya29" /><br />
+        <sub><b>@bhavyapandiya29</b></sub>
+      </a>
+    </td>
     <td align="center" width="120">
       <a href="https://github.com/codewithakshyaaa">
         <img src="https://github.com/codewithakshyaaa.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="codewithakshyaaa" /><br />
@@ -534,14 +540,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
         <sub><b>@iamprasoon2006-cell</b></sub>
       </a>
     </td>
+  </tr>
+  <tr>
     <td align="center" width="120">
       <a href="https://github.com/itsdakshjain">
         <img src="https://github.com/itsdakshjain.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="itsdakshjain" /><br />
         <sub><b>@itsdakshjain</b></sub>
       </a>
     </td>
-  </tr>
-  <tr>
     <td align="center" width="120">
       <a href="https://github.com/jeetrouth">
         <img src="https://github.com/jeetrouth.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="jeetrouth" /><br />
@@ -572,14 +578,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
         <sub><b>@mahi-8758</b></sub>
       </a>
     </td>
+  </tr>
+  <tr>
     <td align="center" width="120">
       <a href="https://github.com/mrinmoyChakraborty-mrinox">
         <img src="https://github.com/mrinmoyChakraborty-mrinox.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="mrinmoyChakraborty-mrinox" /><br />
         <sub><b>@mrinmoyChakraborty-mrinox</b></sub>
       </a>
     </td>
-  </tr>
-  <tr>
     <td align="center" width="120">
       <a href="https://github.com/n1o5">
         <img src="https://github.com/n1o5.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="n1o5" /><br />
@@ -610,14 +616,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
         <sub><b>@parasmani-dev</b></sub>
       </a>
     </td>
+  </tr>
+  <tr>
     <td align="center" width="120">
       <a href="https://github.com/parulpaliwal01">
         <img src="https://github.com/parulpaliwal01.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="parulpaliwal01" /><br />
         <sub><b>@parulpaliwal01</b></sub>
       </a>
     </td>
-  </tr>
-  <tr>
     <td align="center" width="120">
       <a href="https://github.com/pragya-manna">
         <img src="https://github.com/pragya-manna.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="pragya-manna" /><br />
@@ -648,14 +654,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
         <sub><b>@rashiaggarwal06</b></sub>
       </a>
     </td>
+  </tr>
+  <tr>
     <td align="center" width="120">
       <a href="https://github.com/rishit537">
         <img src="https://github.com/rishit537.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="rishit537" /><br />
         <sub><b>@rishit537</b></sub>
       </a>
     </td>
-  </tr>
-  <tr>
     <td align="center" width="120">
       <a href="https://github.com/sakshicoded1111">
         <img src="https://github.com/sakshicoded1111.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="sakshicoded1111" /><br />
@@ -686,14 +692,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
         <sub><b>@shreyasgawande19</b></sub>
       </a>
     </td>
+  </tr>
+  <tr>
     <td align="center" width="120">
       <a href="https://github.com/siri-004">
         <img src="https://github.com/siri-004.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="siri-004" /><br />
         <sub><b>@siri-004</b></sub>
       </a>
     </td>
-  </tr>
-  <tr>
     <td align="center" width="120">
       <a href="https://github.com/snehacodes-2906">
         <img src="https://github.com/snehacodes-2906.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="snehacodes-2906" /><br />
@@ -724,14 +730,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
         <sub><b>@tanishkakora</b></sub>
       </a>
     </td>
+  </tr>
+  <tr>
     <td align="center" width="120">
       <a href="https://github.com/twinkle0tech">
         <img src="https://github.com/twinkle0tech.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="twinkle0tech" /><br />
         <sub><b>@twinkle0tech</b></sub>
       </a>
     </td>
-  </tr>
-  <tr>
     <td align="center" width="120">
       <a href="https://github.com/vedansht2211">
         <img src="https://github.com/vedansht2211.png?size=100" width="100" height="100" style="border-radius:50%; border:2px solid #555;" alt="vedansht2211" /><br />
@@ -762,7 +768,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
         <sub><b>@yuvraj-k-singh</b></sub>
       </a>
     </td>
-    <td width="120"></td>
   </tr>
 </table>
 <!-- CONTRIBUTORS_END -->

games/Rock-Paper-Scissor/Rock-Paper-Scissor.py

@@ -1,44 +1,46 @@
-class Rock_Paper_Scissor:
+import random
+
+class Rock_Paper_Scissors:
     def __init__(self):
+        """Initializes the game state without blocking execution."""
         self.user_score = 0
         self.computer_score = 0
         self.rounds_played = 0 
-        self.play_game()
+        # Perfectly mirrors the JS choices array ['rock', 'paper', 'scissors']
+        self.choices = ["rock", "paper", "scissors"]
 
     def users_play(self):
-        import random
-        choices = ["rock", "paper", "scissor"]
-        
+        """Handles a single round of interaction."""
         user_choice = ""
-        while user_choice not in choices:
-            user_choice = input("Enter your choice (rock, paper, or scissor): ").lower()
-            if user_choice not in choices:
-                print("Invalid choice. Please choose rock, paper, or scissor.")
+        while user_choice not in self.choices:
+            user_choice = input("Enter your choice (rock, paper, or scissors): ").lower()
+            if user_choice not in self.choices:
+                print("Invalid choice. Please choose rock, paper, or scissors.")
 
-        computer_choice = random.choice(choices)
+        computer_choice = random.choice(self.choices)
         print(f"Computer chose: {computer_choice}")
 
         if user_choice == computer_choice:
-            print("It's a Tie!")
+            print("It's a Tie! 🤝")
             return "tie"
-        elif (user_choice == "rock" and computer_choice == "scissor") or \
+        elif (user_choice == "rock" and computer_choice == "scissors") or \
              (user_choice == "paper" and computer_choice == "rock") or \
-             (user_choice == "scissor" and computer_choice == "paper"):
-            print("You Win this round!")
+             (user_choice == "scissors" and computer_choice == "paper"):
+            print("You Win this round! 🎉")
             return "user"
         else:
-            print("Computer Wins this round!")
+            print("Computer Wins this round! 🤖")
             return "computer"
 
-
     def statistics(self):
+        """Displays performance statistics matching the web dashboard metrics."""
         print("\n--- Game Statistics ---")
         print(f"Rounds Played: {self.rounds_played}")
         print(f"Your Score: {self.user_score}")
         print(f"Computer Score: {self.computer_score}")
 
-
     def save_game(self):
+        """Appends the final game results to a local tracking log."""
         name = input("Enter your name to save the results (optional): ")
         if not name:
             name = "Anonymous"
@@ -50,27 +52,29 @@ def save_game(self):
         except IOError:
             print("Error: Could not save game results to file.")
 
-
     def play_game(self): 
+        """Launches the primary interactive gameplay loop."""
         print("Welcome to Rock, Paper, Scissors!")
         while True:
             self.rounds_played += 1
             print(f"\n--- Round {self.rounds_played} ---")
 
-            round_winner = self.users_play() # Call the users_play method for one round
+            round_winner = self.users_play()
 
             if round_winner == "user":
                 self.user_score += 1
             elif round_winner == "computer":
                 self.computer_score += 1
 
             self.statistics()
-            play_again_input = input("do you want to play again ? (yes/no): ").lower()
+            play_again_input = input("Do you want to play again? (yes/no): ").lower()
             if play_again_input != "yes":
                 print("\nThanks for playing! Final results:")
                 self.statistics()
                 self.save_game()
                 break
-        
-game = Rock_Paper_Scissor()
-print(game)
+
+# Standard execution block ensuring clean instantiation
+if __name__ == "__main__":
+    game = Rock_Paper_Scissors()
+    game.play_game()