Merge branch 'main' into fix/broken-markdown-links

Author: tannaya7

.github/workflows/pr-check-primary-codeql.yml

@@ -42,7 +42,7 @@ jobs:
                   egress-policy: audit
 
             - name: Initialize CodeQL
-              uses: github/codeql-action/init@c10b8064de6f491fea524254123dbe5e09572f13 # v4.3.5
+              uses: github/codeql-action/init@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4.3.5
               with:
                   languages: ${{ matrix.language }}
                   build-mode: ${{ matrix.build-mode }}
@@ -66,6 +66,6 @@ jobs:
               run: uv sync --all-extras --dev
 
             - name: Perform CodeQL Analysis
-              uses: github/codeql-action/analyze@c10b8064de6f491fea524254123dbe5e09572f13 # v4.3.5
+              uses: github/codeql-action/analyze@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4.3.5
               with:
                   category: "/language:${{matrix.language}}"

CONTRIBUTING.md

@@ -106,7 +106,7 @@ We welcome blog posts! Whether you're sharing a tutorial, case study, or your ex
 | [Rebasing](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/rebasing.md) | Keeping branch updated |
 | [Merge Conflicts](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/merge_conflicts.md) | Resolving conflicts |
 | [Types](docs/sdk_developers/types.md) | Python type hints |
-| [Linting](docs/sdk_developers/linting.md) | Code quality tools |
+| [Linting](docs/sdk_developers/ruff.md) | Code quality tools |
 
 ---
 

README.md

@@ -72,7 +72,7 @@ print(f"Balance: {balance.hbars} HBAR")
 - **[Rebasing Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/rebasing.md)** - Keep your branch up-to-date
 - **[Merge Conflicts Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/merge_conflicts.md)** - Resolve conflicts
 - **[Typing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/types.md)** - Python type hints
-- **[Linting Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/linting.md)** - Code quality tools
+- **[Linting Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/ruff.md)** - Code quality tools
 
 ### Hedera Network Resources
 

docs/sdk_developers/ruff.md

@@ -100,6 +100,33 @@ uv run ruff check . && uv run ruff format --check .
 }
 ```
 
+
+## 🛠️ Handling Linting Issues
+
+### Manual vs. Automatic Fixes
+
+Ruff is smart, but it won't change your code if it might break logic.
+
+- **Auto-Fixed:** Unused imports, unsorted imports (Isort-style), and basic whitespace.
+
+- **Manual Action Required:** Complex issues like unused function arguments (`ARG001`), overly complex logic (`C901`), or missing docstrings. You must refactor these yourself based on the terminal output.
+
+
+### Ignoring Rules (Suppressing Warnings)
+
+Sometimes, a linter rule conflicts with a specific technical requirement. You can tell Ruff to ignore a line using the `# noqa` comment followed by the error code.
+
+```python
+# Ignore a specific error on a line
+import unused_module  # noqa: F401
+
+# Ignore multiple errors on a line
+x = 1 # noqa: E701, F841
+```
+Each error has a code. You can look up the full details of any code in the [Ruff Documentation](https://docs.astral.sh/ruff/rules/).
+
+> **Global Ignore:** To disable linting for an entire file (e.g., an auto-generated file), add `# ruff: noqa` to the very top
+
 ## 📝 Example Output
 **When issues are found:**
 

docs/sdk_developers/setup.md

@@ -8,7 +8,9 @@ This guide walks you through setting up your development environment for contrib
 - [Installation](#installation)
   - [Installing from PyPI](#installing-from-pypi)
   - [Installing from Source](#installing-from-source)
-  - [Local Editable Installation](#local-editable-installation)
+- [Install Dependencies](#install-dependencies)
+- [Installing Optional Dependencies](#installing-optional-dependencies)
+- [Pre-Commit Tool Setup](#pre-commit-tool-setup)
 - [Generate Protocol Buffers](#generate-protocol-buffers)
 - [Environment Setup](#environment-setup)
 - [Setup Checklist](#examples)
@@ -178,6 +180,9 @@ uv sync --dev --all-extras
 
 To maintain high code quality and security, this repository uses `re-commit` hooks. These hooks automatically run checks (like `Ruff` for linting and `Gitleaks` for security) every time you attempt to commit code.
 
+### Installation
+---
+
 **Option 1: Using `uv` (Recommended)**
 
 `uv` is recommended because it manages pre-commit within your project’s locked environment, ensuring your local linting matches the CI exactly.
@@ -210,6 +215,20 @@ Once installed, `git commit` will automatically trigger the checks.
 - If they **pass**: Your commit is created normally.
 - If they **fail**: The hooks will often fix the files for you (e.g., `Ruff` reformatting). Simply `git add` the changed files and commit again.
 
+
+### Manual Execution
+---
+To run the hooks manually at any time:
+
+```
+# Run against only changed files
+uv run pre-commit run
+
+# Run against every file in the repository
+uv run pre-commit run --all-files
+```
+
+
 ## Generate Protocol Buffers
 
 The SDK uses protocol buffers to communicate with the Hedera network. Generate the Python code from the protobuf definitions: