Fix pre-commit formatting issues and enhance pre-commit setup

- Remove trailing whitespace from .github/copilot-instructions.md
- Add missing newline at end of file
- Create setup script at .github/scripts/setup-precommit.sh
- Update CONTRIBUTING.md with comprehensive pre-commit guide
- Ensure all pre-commit checks pass before committing

Co-authored-by: commjoen <[email protected]>

Author: Copilot

.github/copilot-instructions.md

@@ -47,24 +47,24 @@ wrongsecrets/
 ```java
 @Component
 public class Challenge[Number] extends FixedAnswerChallenge {
-    
+
     private final RuntimeEnvironment runtimeEnvironment;
-    
+
     public Challenge[Number](RuntimeEnvironment runtimeEnvironment) {
         this.runtimeEnvironment = runtimeEnvironment;
     }
-    
+
     @Override
     public String getAnswer() {
         // Return the secret that users need to find
         return "the-secret-value";
     }
-    
+
     @Override
     public boolean canRunInCTFMode() {
         return true; // Set to false if challenge can't run in CTF mode
     }
-    
+
     @Override
     public RuntimeEnvironment.Environment supportedRuntimeEnvironments() {
         return RuntimeEnvironment.Environment.DOCKER; // or ALL, K8S, etc.
@@ -77,17 +77,17 @@ public class Challenge[Number] extends FixedAnswerChallenge {
 ```java
 @Component
 public class Challenge[Number] implements Challenge {
-    
+
     @Override
     public Spoiler spoiler() {
         return new Spoiler(calculateAnswer());
     }
-    
+
     @Override
     public boolean answerCorrect(String answer) {
         return Objects.equals(calculateAnswer(), answer);
     }
-    
+
     private String calculateAnswer() {
         // Complex logic here
     }
@@ -101,25 +101,25 @@ public class Challenge[Number] implements Challenge {
 ```java
 @ExtendWith(MockitoExtension.class)
 class Challenge[Number]Test {
-    
+
     @Mock
     private RuntimeEnvironment runtimeEnvironment;
-    
+
     @InjectMocks
     private Challenge[Number] challenge;
-    
+
     @Test
     void answerCorrect() {
         // Test the correct answer
         assertTrue(challenge.answerCorrect(challenge.spoiler().solution()));
     }
-    
+
     @Test
     void answerIncorrect() {
         // Test incorrect answers
         assertFalse(challenge.answerCorrect("wrong-answer"));
     }
-    
+
     @Test
     void canRunInCTFMode() {
         // Test CTF mode support
@@ -133,7 +133,7 @@ class Challenge[Number]Test {
 ### Java Conventions
 
 - **Package naming**: Follow existing structure under `org.owasp.wrongsecrets`
-- **Class naming**: 
+- **Class naming**:
   - Challenges: `Challenge[Number]` (e.g., `Challenge1`, `Challenge42`)
   - Tests: `Challenge[Number]Test`
 - **Formatting**: Use standard Spring Boot/Google Java style
@@ -266,4 +266,4 @@ Common environment variables used in challenges:
 - **GitHub Issues**: Search existing issues and discussions
 - **OWASP Slack**: Join #project-wrongsecrets channel
 
-Remember: This is an educational project teaching security through intentionally vulnerable examples. Balance realistic vulnerabilities with clear learning outcomes while keeping the framework itself secure and maintainable.
+Remember: This is an educational project teaching security through intentionally vulnerable examples. Balance realistic vulnerabilities with clear learning outcomes while keeping the framework itself secure and maintainable.

.github/scripts/setup-precommit.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# Setup pre-commit hooks for OWASP WrongSecrets contributors
+# This script ensures that all pre-commit checks are installed and configured
+
+set -e
+
+echo "🔧 Setting up pre-commit hooks for OWASP WrongSecrets..."
+
+# Check if pre-commit is installed
+if ! command -v pre-commit &> /dev/null; then
+    echo "📦 Installing pre-commit..."
+    python3 -m pip install --user pre-commit
+fi
+
+# Install pre-commit hooks
+echo "⚡ Installing pre-commit hooks..."
+pre-commit install
+
+# Install commit-msg hook for commitlint
+echo "📝 Installing commit-msg hook..."
+pre-commit install --hook-type commit-msg
+
+echo "✅ Pre-commit setup complete!"
+echo ""
+echo "📋 Available commands:"
+echo "  pre-commit run --all-files    # Run all hooks on all files"
+echo "  pre-commit run <hook-name>     # Run specific hook"
+echo "  pre-commit autoupdate          # Update hook versions"
+echo ""
+echo "💡 Pre-commit will now run automatically on every commit!"
+echo "   To bypass pre-commit checks (not recommended): git commit --no-verify"

CONTRIBUTING.md

@@ -32,7 +32,10 @@ cd wrongsecrets
 ./mvnw clean compile
 ./mvnw test -Dtest=ChallengesControllerTest
 
-# 3. Run the application locally
+# 3. Setup pre-commit hooks (recommended)
+./.github/scripts/setup-precommit.sh
+
+# 4. Run the application locally
 ./mvnw spring-boot:run
 # Visit http://localhost:8080 to see the app running
 ```
@@ -108,6 +111,41 @@ The minimum requirements for code contributions are:
 
 And please note that this project has *three months* implementation windows. So once you've been assigned to a task/issue, try to make your PR accepted within this period.
 
+### 🔧 Pre-commit Hooks Setup
+
+**Important:** Always run pre-commit checks before submitting your PR to avoid CI failures.
+
+#### Quick Setup
+```bash
+# Automated setup (recommended)
+./.github/scripts/setup-precommit.sh
+
+# Manual setup
+pip install pre-commit
+pre-commit install
+pre-commit install --hook-type commit-msg
+```
+
+#### Running Checks
+```bash
+# Check all files
+pre-commit run --all-files
+
+# Check specific file
+pre-commit run --files path/to/your/file.md
+
+# Check what will run on next commit
+pre-commit run
+```
+
+#### Common Issues & Fixes
+- **Trailing whitespace**: Automatically fixed by pre-commit
+- **Missing newlines**: Automatically fixed by pre-commit  
+- **Java formatting**: Run `./mvnw spotless:apply`
+- **Commit message format**: Follow [Conventional Commits](https://www.conventionalcommits.org/)
+
+💡 **Tip**: Pre-commit hooks will run automatically on every commit after installation!
+
 Additionally, the following guidelines can help:
 
 ### Keep your pull requests limited to a single issue