docs: clean up stale README and apply auto formatting fixes (#47)

* chore(main): release 0.4.0 (#46)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: clean up stale README

* chore: apply auto-formatting fixes

Minor formatting fixes applied by markdownlint and ruff:
- CLAUDE.md: Add blank lines for readability, fix heading level
- docs/RELEASE_PROCESS.md: Add blank lines for list formatting
- src/utils/configuration.py: Fix quote style consistency

* chore: update Docker image to v0.4.0

Updates deployment configurations to use v0.4.0 image version.

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: MoonBoi9001

CLAUDE.md

@@ -153,6 +153,7 @@ The system follows a clear data pipeline with daily scheduled execution:
 This repository uses **release-please** for automated releases:
 
 **Commit Message Format (CRITICAL):**
+
 - Use conventional commits: `feat:`, `fix:`, `chore:`, `refactor:`, `docs:`
 - release-please auto-generates CHANGELOG and handles versioning
 - Examples:
@@ -161,11 +162,13 @@ This repository uses **release-please** for automated releases:
   - `feat!: change API structure` (major version bump)
 
 **DO NOT:**
+
 - Manually edit CHANGELOG.md for new changes (release-please updates it)
 - Manually create git tags (release-please creates them)
 - Manually create GitHub releases (release-please handles this)
 
 **Release Process:**
+
 1. Push commits with conventional format to `main`
 2. release-please creates/updates a Release PR automatically
 3. Review and merge the Release PR
@@ -218,6 +221,6 @@ See [docs/RELEASE_PROCESS.md](./docs/RELEASE_PROCESS.md) for full details.
 3. Contact repository administrators to discuss history rewriting if necessary
 4. Consider the credential permanently compromised
 
-# Style Guidelines Import
+## Style Guidelines Import
 
 @./STYLE_GUIDELINES.md

README.md

@@ -7,6 +7,7 @@ This repository implements a Docker container service for the Rewards Eligibilit
 ### Key Features
 
 The oracle runs with the following functionality:
+
 - **BigQuery Integration**: Fetches indexer performance data from Google BigQuery
 - **Eligibility Processing**: Applies threshold algorithm to determine rewards eligibility based on service quality
 - **Blockchain Integration**: Posts rewards eligibility updates to the RewardsEligibilityOracle contract
@@ -21,24 +22,13 @@ The oracle includes built-in Slack notifications for operational monitoring:
 
 - **Success Notifications**: Sent when oracle runs complete successfully, including transaction details
 - **Failure Notifications**: Sent when errors occur, with detailed error information for debugging
-- **Simple & Reliable**: Direct notifications from the oracle process itself
 
 For production deployments, container orchestration (Kubernetes) should handle:
+
 - Container health monitoring and restarts
 - Resource management and scaling
 - Infrastructure-level alerts and monitoring
 
-### Testing Notifications
-
-Test notification functionality:
-```bash
-# Set webhook URL
-export SLACK_WEBHOOK_URL="your_webhook_url"
-
-# Run notification tests
-./scripts/test_slack_notifications.py
-```
-
 ## Configuration
 
 ## Eligibility Criteria
@@ -71,73 +61,37 @@ Automated quality checks and security scanning via GitHub Actions. Run `./script
 
 For details: [.github/README.md](./.github/README.md)
 
-## Getting Started
-
-### Quick Start with Docker
-
-1. **Clone the repository**:
-   ```bash
-   git clone https://github.com/graphprotocol/service-quality-oracle.git
-   cd service-quality-oracle
-   ```
-
-2. **Set up environment variables/config.toml**:
-
-3. **Build and run with Docker Compose**:
-   ```bash
-   docker-compose up --build -d
-   ```
-
-4. **Monitor logs**:
-   ```bash
-   docker-compose logs -f
-   ```
-
-5. **Check health status**:
-   ```bash
-   docker-compose ps
-   ```
-
 ### Development Workflow
 
 For contributors working on the codebase:
 
 **Before pushing:**
-   ```bash
-   # Setup venv
-   python3 -m venv venv
-   source venv/bin/activate
 
-   # Install requirements
-   pip install -r requirements.txt
+```bash
+# Setup venv
+python3 -m venv venv
+source venv/bin/activate
+
+# Install requirements
+pip install -r requirements.txt
+
+# Use the custom ruff script for linting (includes SQL formatting and aggressive linting)
+./scripts/ruff_check_format_assets.sh
 
-   # Use the custom ruff script for linting (includes SQL formatting and aggressive linting)
-   ./scripts/ruff_check_format_assets.sh
-   ```
+# Use markdownlint to lint and fix markdown files
+markdownlint '**/*.md' --ignore 'venv/**' --ignore 'node_modules/**' --fix
+```
 
 **Optional checks:**
+
 ```bash
 mypy src/ --ignore-missing-imports
 bandit -r src/
 ```
 
-> **Note:** The CI/CD pipeline uses the custom `ruff_check_format_assets.sh` script which includes SQL whitespace fixes and more aggressive formatting than standard ruff. 
-> 
+> **Note:** The CI/CD pipeline uses the custom `ruff_check_format_assets.sh` script which includes SQL whitespace fixes and more aggressive formatting than standard ruff.
 > Always run this script locally before pushing to avoid CI failures.
 
 ## License
 
 [License information to be determined.]
-
-## TODO List (only outstanding TODOs)
-
-### 1. Testing
-- [ ] Security review of code and dependencies
-
-### 2. Documentation
-- [ ] Documentation of all major components
-- [ ] Document operational procedures
-
-### 3. Optimization
-- [ ] Optimize dependencies and container setup
-- [ ] Ensure unused files, functions & dependencies are removed from codebase

docker-compose.yml

@@ -9,7 +9,7 @@ services:
     container_name: service-quality-oracle
 
     # Set the image name
-    image: ghcr.io/graphprotocol/rewards-eligibility-oracle:v0.3.0
+    image: ghcr.io/graphprotocol/rewards-eligibility-oracle:v0.4.0
 
     volumes:
       # Mount data directory to store data

docs/RELEASE_PROCESS.md

@@ -50,6 +50,7 @@ When commits are pushed to `main`, release-please:
 4. Creates/updates a "Release PR" with all changes
 
 **Example Release PR:**
+
 - Title: `chore(main): release 0.4.0`
 - Changes: Updated CHANGELOG.md, version bump
 - Body: Lists all changes since last release
@@ -63,6 +64,7 @@ To create a release:
 3. Merge the Release PR
 
 When merged, release-please automatically:
+
 - Creates a Git tag (e.g., `v0.4.0`)
 - Creates a GitHub Release with changelog
 - Triggers CD workflow to build and publish Docker images

k8s/deployment.yaml

@@ -16,7 +16,7 @@ spec:
     spec:
       containers:
       - name: service-quality-oracle
-        image: ghcr.io/graphprotocol/service-quality-oracle:latest
+        image: ghcr.io/graphprotocol/service-quality-oracle:v0.4.0
         envFrom:
         # Load all non-sensitive configuration from ConfigMap
         - configMapRef:

src/utils/configuration.py

@@ -355,7 +355,7 @@ def get_google_credentials(self) -> google.auth.credentials.Credentials:
             cred_type = type(credentials).__name__
 
             # Show service account email if available (service accounts have this attribute)
-            if hasattr(credentials, 'service_account_email'):
+            if hasattr(credentials, "service_account_email"):
                 logger.info(
                     f"Loaded {cred_type} credentials from {creds_source} "
                     f"for project {project} (service account: {credentials.service_account_email})"