chore: Added prompt for coderabbit to review Query classes (hiero-ledger#1411)

Signed-off-by: Manish Dait <daitmanish88@gmail.com>

Author: manishdait

.coderabbit.yaml

@@ -19,6 +19,126 @@ reviews:
   poem: false # Do not write a literal poem (spammy)
   enable_prompt_for_ai_agents: false # Disable prompts for AI agents (spammy)
 
+  # QUERY REVIEW INSTRUCTIONS
+  query_review_instructions: &query_review_instructions | 
+    You are acting as a senior maintainer reviewing the Query base class
+    and its subclasses for the hiero-sdk-python project.
+    
+    NOTE:
+    - Review focus levels indicate areas that are important to check carefully.
+    - They do NOT imply severity or urgency.
+    - Only recommend fixes when there is a clear behavioral regression.
+    
+    Scope is STRICTLY LIMITED to:
+    - Changes to the base `Query` class
+    - Changes to existing `Query` subclasses
+    - Newly added `Query` subclasses
+    
+    ----------------------------------------------------------
+    REVIEW FOCUS 1 — QUERY SEMANTICS & PAYMENT BEHAVIOR
+    (CONTRACTUAL / HIGH SENSITIVITY)
+    ----------------------------------------------------------
+    Queries do not reach consensus and use `QueryHeader` for payment and responseType.
+    
+    The following behaviors are contractual and must remain unchanged:
+    - `_is_payment_required()` semantics
+    - FREE vs PAID query classification
+    - COST_ANSWER vs ANSWER_ONLY behavior
+    - Whether a payment transaction is attached
+    
+    Good to check and verify that changes do NOT:
+    - Alter FREE → PAID or PAID → FREE behavior
+    - Attach payment to COST_ANSWER queries
+    - Bypass `get_cost(client)` for paid queries
+    - Hardcode fees or override payment logic
+    
+    ----------------------------------------------------------
+    REVIEW FOCUS 2 — EXECUTION LIFECYCLE & BASE CLASS INTEGRITY
+    ----------------------------------------------------------
+    All queries MUST:
+    - Use the base `Query` execution flow
+    - Delegate retries, backoff, and node selection to `_Executable`
+    - Call `_before_execute(client)` before `_execute(client)`
+    
+    Subclasses MUST NOT:
+    - Override retry logic
+    - Implement custom node selection
+    - Manage gRPC deadlines manually
+    - Bypass `_Executable` state handling
+    
+    Flag deviations for review; recommend fixes only if behavior changes.
+    
+    ----------------------------------------------------------
+    REVIEW FOCUS 3 — REQUEST CONSTRUCTION CONTRACT
+    ----------------------------------------------------------
+    `_make_request()` MUST:
+    - Validate all required identifiers (accountId, tokenId, topicId, etc.)
+    - Call `_make_request_header()` exactly once
+    - Populate protobuf fields via `_to_proto()` helpers
+    - Avoid manual `QueryHeader` mutation
+        
+    Subclasses MUST NOT:
+    - Set `responseType` directly
+    - Inject payment logic
+    - Rebuild headers manually
+    
+    ----------------------------------------------------------
+    REVIEW FOCUS 4 — RESPONSE EXTRACTION & DOMAIN MAPPING
+    ----------------------------------------------------------
+    `_get_query_response()` MUST:
+    - Return the exact protobuf response field
+    - Perform NO data transformation
+    - Match the expected protobuf response type
+    
+    `execute()` MUST NOT:
+    - Implement retries or error handling
+    - Modify payment or execution behavior
+    - Catch and suppress execution errors
+    
+    ----------------------------------------------------------
+    REVIEW FOCUS 5 — NEW SUBCLASS VALIDATION
+    ----------------------------------------------------------
+    For newly added `Query` subclasses:
+    - Ensure they extend `Query` directly
+    - Verify required abstract methods are implemented
+    - Confirm payment semantics match the Hedera API
+    - Validate protobuf service and method correctness
+    - Ensure naming matches existing query patterns
+    
+    Missing or incorrect semantics should be flagged clearly.
+    
+    ----------------------------------------------------------
+    REVIEW FOCUS 6 — REGRESSION & BEHAVIOR CHANGE DETECTION
+    ----------------------------------------------------------
+    Good to check whether any change:
+    - Alters base `Query` behavior
+    - Changes default responseType handling
+    - Modifies `_make_request_header()` usage
+    - Alters `_get_method()` behavior
+    - Introduces side effects (logging, prints, stack traces)
+    - Changes error propagation behavior
+    
+    Small changes should be flagged for verification
+    if they could affect execution flow or payment safety.
+    
+    ----------------------------------------------------------
+    REVIEW FOCUS 7 — EXPLICIT NON-GOALS
+    ----------------------------------------------------------
+    Do NOT:
+    - Review query consumers
+    - Propose refactors unless correctness is impacted
+    - Comment on style, formatting, or naming unless misleading
+    
+    ----------------------------------------------------------
+    FINAL OBJECTIVE
+    ----------------------------------------------------------
+    Ensure Query code remains:
+    - Backward-compatible
+    - Payment-safe
+    - Execution-consistent
+    - Strictly aligned with Hedera query semantics
+
+
   # ============================================================
   # GLOBAL REVIEW INSTRUCTIONS (APPLY TO ALL FILES)
   # ============================================================
@@ -32,7 +152,6 @@ reviews:
       - Do NOT block the PR on them.
       - Do NOT suggest fixes inline.
       - Instead, aggregate all out-of-scope issues into a single comment with a list of recommendations for one or more follow-up issues that can be created.
-
   path_instructions:
     # --- CUSTOM INSTRUCTIONS FOR EXAMPLES DIRECTORY ---
     - path: "examples/**/*"
@@ -423,6 +542,13 @@ reviews:
         - Scripts MUST NOT assume write access
         - Permission failures MUST be handled gracefully
 
+    - path: "src/hiero_sdk_python/query/**/*.py"
+      instructions: *query_review_instructions
+    
+    - path: "src/hiero_sdk_python/contract/**/*_query.py"
+      instructions: *query_review_instructions
+        
+
 chat:
   art: false # Don't draw ASCII art (false)
   auto_reply: false # Don't allow bot to converse (spammy)

CHANGELOG.md

@@ -93,6 +93,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - Chained Good First Issue assignment with mentor assignment to bypass GitHub's anti-recursion protection - mentor assignment now occurs immediately after successful user assignment in the same workflow execution. (#1369)
 - Add GitHub Actions script and workflow for automatic spam list updates.
 - Added technical docstrings and hardening (set -euo pipefail) to the pr-check-test-files.sh script (#1336)
+- Added prompt for coderabbit to review `Query` and it's sub-classes.
 
 ### Changed
 - Renamed `.github/scripts/check_advanced_requirement.sh` to `bot-advanced-check.sh` for workflow consistency (#1341)